github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tidy SLUGIFY_* settings documentation

Browse source
This commit is contained in:
Justin Mayer 2020-04-21 05:36:28 +02:00
commit 021ef45f75
1 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/settings.rst
View file

@ -615,24 +615,22 @@ corresponding ``*_URL`` setting as string, while others hard-code them:
``'archives.html'``, ``'authors.html'``, ``'categories.html'``, ``'archives.html'``, ``'authors.html'``, ``'categories.html'``,
``'tags.html'``. ``'tags.html'``.
.. data:: SLUGIFY_SOURCE = 'title' .. data:: SLUGIFY_SOURCE = 'title'
Specifies where you want the slug to be automatically generated from. Can be Specifies from where you want the slug to be automatically generated. Can be
set to ``title`` to use the 'Title:' metadata tag or ``basename`` to use the set to ``title`` to use the "Title:" metadata tag or ``basename`` to use the
article's file name when creating the slug. article's file name when creating the slug.
.. data:: SLUGIFY_USE_UNICODE = False .. data:: SLUGIFY_USE_UNICODE = False
Allow unicode characters in slugs. Set ``True`` to keep unicode characters Allow Unicode characters in slugs. Set ``True`` to keep Unicode characters
in auto-generated slugs. Otherwise, unicode characters will be replaced in auto-generated slugs. Otherwise, Unicode characters will be replaced
with ASCII equivalents. with ASCII equivalents.
.. data:: SLUGIFY_PRESERVE_CASE = False .. data:: SLUGIFY_PRESERVE_CASE = False
Preserve uppercase characters in the slugs. Set ``True`` to keep the Preserve uppercase characters in slugs. Set ``True`` to keep uppercase
uppercase characters in the ``SLUGIFY_SOURCE`` as is. characters from ``SLUGIFY_SOURCE`` as-is.
.. data:: SLUG_REGEX_SUBSTITUTIONS = [ .. data:: SLUG_REGEX_SUBSTITUTIONS = [
(r'[^\\w\\s-]', ''), # remove non-alphabetical/whitespace/'-' chars (r'[^\\w\\s-]', ''), # remove non-alphabetical/whitespace/'-' chars