centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #994 from waylan/master

Browse Source 
Document `pages` config setting default behavior.
This commit is contained in:
Waylan Limberg
2016-07-18 16:00:23 -04:00
committed by GitHub
parent a64ed3a5dd f4d0f11335
commit d790defd85
2 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/user-guide/configuration.md
View File

@@ -162,6 +162,10 @@ See the section on [configuring pages and
navigation](/user-guide/writing-your-docs.md#configure-pages-and-navigation) for
a more detailed breakdown, including how to create sub-sections.
**default**: By default `pages` will contain an alphanumerically sorted, nested
list of all the Markdown files found within the `docs_dir` and its
sub-directories. If none are found it will be `[]` (an empty list).
## Build directories
### theme

5
docs/user-guide/writing-your-docs.md
View File

@@ -10,7 +10,10 @@ The [pages configuration](/user-guide/configuration.md#pages) in your
`mkdocs.yml` defines which pages are built by MkDocs and how they appear in the
documentation navigation. If not provided, the pages configuration will be
automatically created by discovering all the Markdown files in the
[documentation directory](/user-guide/configuration.md#docs_dir).
[documentation directory](/user-guide/configuration.md#docs_dir). An
automatically created pages configuration will always be sorted
alphanumerically by file name. You will need to manually define your pages
configuration if you would like your pages sorted differantly.
A simple pages configuration looks like this: