Skip to content

Commit

Permalink
Fix #3579 — update notes about title/slug being required
Browse files Browse the repository at this point in the history
  • Loading branch information
Kwpolska committed Oct 11, 2021
1 parent db97e3d commit 9f10746
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,12 +285,12 @@ Basic

title
Title of the post. Using HTML/math in titles is not supported/recommended.
(required)
If not specified, the file name will be used.

slug
Slug of the post. Used as the last component of the page URL. We recommend
and default to using a restricted character set (``a-z0-9-_``) because
other symbols may cause issues in URLs. (required)
other symbols may cause issues in URLs. If not specified, the file name will be used.

So, if the slug is "the-slug" the page generated would be "the-slug.html" or
"the-slug/index.html" (if you have the pretty URLs option enabled)
Expand Down

0 comments on commit 9f10746

Please sign in to comment.