From 4814fbce640790d015400ce55671e6bbc74b0eb6 Mon Sep 17 00:00:00 2001
From: Patrick Marsceill <patrick.marsceill@gmail.com>
Date: Fri, 16 Nov 2018 14:55:20 -0500
Subject: [PATCH] Content cleanup
---
docs/navigation-structure.md | 8 ++++++++
index.md | 2 +-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md
index d9667139..eab6e731 100644
--- a/docs/navigation-structure.md
+++ b/docs/navigation-structure.md
@@ -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.
+#### Example
+{: .no_toc }
```yaml
---
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.
+#### Example
+{: .no_toc }
```yaml
---
layout: default
@@ -87,12 +91,14 @@ On the parent pages, add 3 YAML front matter variables:
{: .no_toc }
```yaml
+---
layout: default
title: UI Components
nav_order: 2
has_children: true
parent: 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.
@@ -104,10 +110,12 @@ On child pages, simply set the `parent:` YAML front matter to whatever the paren
#### Example
{: .no_toc }
```yaml
+---
layout: default
title: Buttons
parent: UI Components
nav_order: 2
+---
```
The Buttons page appears a child of UI Components and appears second in the UI Components section.
diff --git a/index.md b/index.md
index 192cfeca..3ad9ca67 100644
--- a/index.md
+++ b/index.md
@@ -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.
### 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
remote_theme: pmarsceill/just-the-docs
```
--
GitLab