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

Explain how to use theme locally with GitHub Pages

Browse Source
This commit is contained in:
Gus Narea 2019-04-17 23:41:04 +01:00
parent b44efbf1da
commit afaa3ab225
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
index.md
View File

@ -30,6 +30,8 @@ remote_theme: pmarsceill/just-the-docs
```
<small>You must have GitHub Pages enabled on your repo, one or more Markdown files, and a `_config.yml` file. [See an example repository](https://github.com/pmarsceill/jtd-remote)</small>
[Set up GitHub Pages locally](https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll) so that you can also use this theme locally.
### Local installation: Use the gem-based theme
1. Install the Ruby Gem