README.md in jekyll-readthedocs-0.1.0 vs README.md in jekyll-readthedocs-0.2.0
- old
+ new
@@ -1,12 +1,12 @@
# Jekyll ReadTheDocs
*Jekyll-ReadTheDocs is a fork of Jekyll's Minima base theme. Documentation below may refer to minima instead of this fork.*
-[Theme preview](https://jekyll.github.io/minima/)
+[Theme preview](http://pawamoy.github.io/) (my own blog using this theme).
-
+
## Installation
Add this line to your Jekyll site's Gemfile:
@@ -23,10 +23,25 @@
And then execute:
$ bundle
+### With GitHub Pages
+To use this theme with GitHub Pages, you might need to declare the theme as remote in your `_config.yml` file:
+
+```yaml
+#theme: jekyll-readthedocs
+remote_theme: pawamoy/jekyll-readthedocs
+```
+
+And your `Gemfile` should be:
+
+```ruby
+source "https://rubygems.org"
+gem 'github-pages', group: :jekyll_plugins
+```
+
### Layouts
Refers to files within the `_layouts` directory, that define the markup for your theme.
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
@@ -81,9 +96,11 @@
This section is optional from Minima v2.2 onwards.<br/>
It will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to `show_drafts`).
The title for this section is `Posts` by default and rendered with an `<h2>` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.
+
+To add post excerpts in the post listing, set `use_excerpt: true` in `_config.yml`.
--
### Customization