mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-08 04:51:23 -06:00
Merge pull request #778 from just-the-docs/fix-toc-on-index
Fix ol on index
This commit is contained in:
commit
25aa612617
46
index.md
46
index.md
@ -35,38 +35,32 @@ remote_theme: just-the-docs/just-the-docs
|
|||||||
### Local installation: Use the gem-based theme
|
### Local installation: Use the gem-based theme
|
||||||
|
|
||||||
1. Install the Ruby Gem
|
1. Install the Ruby Gem
|
||||||
|
```bash
|
||||||
```bash
|
$ gem install just-the-docs
|
||||||
$ gem install just-the-docs
|
```
|
||||||
```
|
```yaml
|
||||||
|
# .. or add it to your your Jekyll site’s Gemfile
|
||||||
```yaml
|
gem "just-the-docs"
|
||||||
# .. or add it to your your Jekyll site’s Gemfile
|
```
|
||||||
gem "just-the-docs"
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Add Just the Docs to your Jekyll site’s `_config.yml`
|
2. Add Just the Docs to your Jekyll site’s `_config.yml`
|
||||||
|
```yaml
|
||||||
```yaml
|
theme: "just-the-docs"
|
||||||
theme: "just-the-docs"
|
```
|
||||||
```
|
|
||||||
|
|
||||||
3. _Optional:_ Initialize search data (creates `search-data.json`)
|
3. _Optional:_ Initialize search data (creates `search-data.json`)
|
||||||
|
```bash
|
||||||
```bash
|
$ bundle exec just-the-docs rake search:init
|
||||||
$ bundle exec just-the-docs rake search:init
|
```
|
||||||
```
|
|
||||||
|
|
||||||
3. Run you local Jekyll server
|
3. Run you local Jekyll server
|
||||||
|
```bash
|
||||||
```bash
|
$ jekyll serve
|
||||||
$ jekyll serve
|
```
|
||||||
```
|
```bash
|
||||||
|
# .. or if you're using a Gemfile (bundler)
|
||||||
```bash
|
$ bundle exec jekyll serve
|
||||||
# .. or if you're using a Gemfile (bundler)
|
```
|
||||||
$ bundle exec jekyll serve
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user