From 2990af2b63cc8891f470c64d753bb76894327543 Mon Sep 17 00:00:00 2001 From: Mahdi Majidzadeh <6115476+MahdiMajidzadeh@users.noreply.github.com> Date: Wed, 8 Nov 2017 02:51:02 +0330 Subject: [PATCH] Config docs should match YAML syntax (#1341) --- docs/user-guide/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 69d35150..018fd6e3 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -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