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

Config docs should match YAML syntax (#1341)

Browse Source
This commit is contained in:
Mahdi Majidzadeh
2017-11-08 02:51:02 +03:30
committed by Waylan Limberg
parent 3ff094d510
commit 2990af2b63
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -321,13 +321,13 @@ documentation.
The following table demonstrates how the URLs used on the site differ when
setting `use_directory_urls` to `true` or `false`.
Source file | Generated HTML | use_directory_urls=true | use_directory_urls=false
Source file | Generated HTML | use_directory_urls: true | use_directory_urls: false
------------ | -------------------- | ------------------------ | ------------------------
index.md | index.html | / | /index.html
api-guide.md | api-guide/index.html | /api-guide/ | /api-guide/index.html
about.md | about/index.html | /about/ | /about/index.html
The default style of `use_directory_urls=true` creates more user friendly URLs,
The default style of `use_directory_urls: true` creates more user friendly URLs,
and is usually what you'll want to use.
The alternate style can occasionally be useful if you want your documentation to