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

Clarify docs regarding pages. Fixes #847.

Browse source
This commit is contained in:
Justin Mayer 2013-04-14 15:04:38 -07:00
commit 7b0165696e
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/getting_started.rst
View file

@ -274,10 +274,11 @@ Pages
----- -----
If you create a folder named ``pages`` inside the content folder, all the If you create a folder named ``pages`` inside the content folder, all the
files in it will be used to generate static pages. files in it will be used to generate static pages, such as **About** or
**Contact** pages. (See example filesystem layout below.)
Then, use the ``DISPLAY_PAGES_ON_MENU`` setting to add all those pages to You can use the ``DISPLAY_PAGES_ON_MENU`` setting to control whether all those
the primary navigation menu. pages are displayed in the primary navigation menu. (Default is ``True``.)
If you want to exclude any pages from being linked to or listed in the menu If you want to exclude any pages from being linked to or listed in the menu
then add a ``status: hidden`` attribute to its metadata. This is useful for then add a ``status: hidden`` attribute to its metadata. This is useful for
@ -299,8 +300,9 @@ following syntax: ``|filename|path/to/file``::
website/ website/
├── content ├── content
│   ├── article1.rst │   ├── article1.rst
│   └── cat/ │   ├── cat/
│      └── article2.md │   │   └── article2.md
│ └── pages
└── pelican.conf.py └── pelican.conf.py
In this example, ``article1.rst`` could look like:: In this example, ``article1.rst`` could look like::