The YAML samples were incorrectly being highlighted as dffs

Use fenced code blocks and specify YAML to correct this.
This commit is contained in:
Dougal Matthews
2015-04-03 15:34:34 +01:00
parent 4a529ee63d
commit 7ea8592fe7
2 changed files with 5 additions and 0 deletions

View File

@@ -100,10 +100,12 @@ Let's also add a second page to our documentation:
We'd like our documentation site to include some navigation headers, so we'll edit the configuration file and add some information about the order and title to use for out headers:
```yaml
site_name: MkLorum
pages:
- [index.md, Home]
- [about.md, About]
```
Refresh the browser and you'll now see a navigation bar with `Home` and `About` headers.
@@ -111,11 +113,13 @@ Refresh the browser and you'll now see a navigation bar with `Home` and `About`
While we're here can also change the configuration file to alter how the documentation is displayed. Let's go ahead and change the theme. Edit the `mkdocs.yml` file to the following:
```yaml
site_name: MkLorum
pages:
- [index.md, Home]
- [about.md, About]
theme: readthedocs
```
Refresh the browser again, and you'll now see the ReadTheDocs theme being used.

View File

@@ -90,6 +90,7 @@ The setting should be a list. Each row in the list represents information about
Here's a simple example that would cause the build stage to create three pages:
pages:
- ['index.md', 'Introduction']
- ['user-guide.md', 'User Guide']