steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-28 05:52:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #777 from just-the-docs/readme-update

Browse Source 
Update readme
This commit is contained in:
Patrick Marsceill 2022-03-03 14:52:21 -05:00 committed by GitHub
commit fbf125d525
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -13,6 +13,17 @@
## Installation
### via GitHub Pages remote theme
The quickiest way to use Just The Docs is to use GitHub pages [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) feature in your `config.yml` file:
```yaml
remote_theme: just-the-docs/just-the-docs
```
### via RubyGems:
Alternatively you can install it as a Ruby Gem.
Add this line to your Jekyll site's Gemfile:
```ruby