steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-17 16:42:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Content cleanup

Browse Source
This commit is contained in:
Patrick Marsceill 2018-11-16 14:55:20 -05:00
parent 2568b05fe7
commit 4814fbce64
No known key found for this signature in database
GPG Key ID: 286B93882D828F40
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/navigation-structure.md
View File

@ -27,6 +27,8 @@ By default, all pages will appear as top level pages in the main nav.
To specify a page order, use the `nav_order` variable in your pages' YAML front matter. To specify a page order, use the `nav_order` variable in your pages' YAML front matter.
#### Example
{: .no_toc }
```yaml ```yaml
--- ---
layout: default layout: default
@ -39,6 +41,8 @@ nav_order: 4
For specific pages that you do not wish to include in the main navigation, e.g. a 404 page. Use the `nav_exclude: true` parameter in the YAML front matter for that page. For specific pages that you do not wish to include in the main navigation, e.g. a 404 page. Use the `nav_exclude: true` parameter in the YAML front matter for that page.
#### Example
{: .no_toc }
```yaml ```yaml
--- ---
layout: default layout: default
@ -87,12 +91,14 @@ On the parent pages, add 3 YAML front matter variables:
{: .no_toc } {: .no_toc }
```yaml ```yaml
---
layout: default layout: default
title: UI Components title: UI Components
nav_order: 2 nav_order: 2
has_children: true has_children: true
parent: UI Components parent: UI Components
permalink: /ui-components permalink: /ui-components
---
``` ```
Here we're setting up the UI Components landing page that is available at `/ui-components`, has children and is ordered second in the main nav. Here we're setting up the UI Components landing page that is available at `/ui-components`, has children and is ordered second in the main nav.
@ -104,10 +110,12 @@ On child pages, simply set the `parent:` YAML front matter to whatever the paren
#### Example #### Example
{: .no_toc } {: .no_toc }
```yaml ```yaml
---
layout: default layout: default
title: Buttons title: Buttons
parent: UI Components parent: UI Components
nav_order: 2 nav_order: 2
---
``` ```
The Buttons page appears a child of UI Components and appears second in the UI Components section. The Buttons page appears a child of UI Components and appears second in the UI Components section.

2
index.md
View File

@ -21,7 +21,7 @@ Just the Docs gives your documentation a jumpstart with a responsive Jekyll them
Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/quickstart/) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages standard Jekyll compiler. Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/quickstart/) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages standard Jekyll compiler.
### Quick start: Use as a GitHub Pages remote theme ### Quick start: Use as a GitHub Pages remote theme
1. Add Just the Docs to your Jekyll site's `_config.yml` as a remote theme 1. Add Just the Docs to your Jekyll site's `_config.yml` as a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/)
```yaml ```yaml
remote_theme: pmarsceill/just-the-docs remote_theme: pmarsceill/just-the-docs
``` ```