diff --git a/docs/index.md b/docs/index.md index f08d9b4b..b2c10784 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index acbb0562..fbd5a287 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -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']