From 779990bafe5e2aa467d5daf83da1d4c8122b3bc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Echedey=20L=C3=B3pez=20Romero?= Date: Sun, 3 Jan 2021 04:29:11 +0000 Subject: [PATCH] =?UTF-8?q?A=C3=B1adir=20'about.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- about.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 about.md diff --git a/about.md b/about.md new file mode 100644 index 0000000..a52bc86 --- /dev/null +++ b/about.md @@ -0,0 +1,40 @@ +--- +title: About Garth +--- + +A really basic theme for Jekyll, using the official Jekyll theme implementation. + +- [Fork on GitHub](https://github.com/daviddarnes/garth) +- [Install Garth](https://github.com/daviddarnes/garth#installation) + +[](https://buymeacoffee.com/daviddarnes#support) + +## Installation + +### As a Jekyll theme + +1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy +2. Run the command `bundle install` in the root of project to install the theme and its dependancies +3. Add `theme: garth-jekyll-theme` to your `_config.yml` file to set the site theme +4. Run `bundle exec jekyll serve` to build and serve your site +5. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options + +### As a GitHub Pages remote theme + +1. Add `gem "jekyll-remote-theme"` to your `Gemfile` to add the theme as a dependancy +2. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy +3. Add `jekyll-remote-theme` to the list of `plugins` in your `_config.yml` file +4. Add `remote_theme: daviddarnes/garth` to your `_config.yml` file to set the site theme +5. Run `bundle exec jekyll serve` to build and serve your site +6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options + +### As a Boilerplate / Fork + +_(deprecated, not recommended)_ + +1. [Fork the repo](https://github.com/daviddarnes/garth#fork-destination-box) +2. Replace the `Gemfile` with one stating all the gems used in your project +3. Delete the following unnecessary files/folders: `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png`, `CNAME` and `garth-jekyll-theme.gemspec` +4. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy +5. Run `bundle exec jekyll serve` to build and serve your site +6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options \ No newline at end of file