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

If PATH is undefined, Pelican uses PWD as content

Browse source
This commit is contained in:
Justin Mayer 2014-05-13 07:18:33 -07:00
commit 9d2a129832
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/settings.rst
View file

@ -94,7 +94,7 @@ Setting name (followed by default value, if any)
``READERS = {}`` A dictionary of file extensions / Reader classes for Pelican to ``READERS = {}`` A dictionary of file extensions / Reader classes for Pelican to
process or ignore. For example, to avoid processing .html files, process or ignore. For example, to avoid processing .html files,
set: ``READERS = {'html': None}``. To add a custom reader for the set: ``READERS = {'html': None}``. To add a custom reader for the
`foo` extension, set: ``READERS = {'foo': FooReader}`` ``foo`` extension, set: ``READERS = {'foo': FooReader}``
``IGNORE_FILES = ['.#*']`` A list of file globbing patterns to match against the ``IGNORE_FILES = ['.#*']`` A list of file globbing patterns to match against the
source files to be ignored by the processor. For example, source files to be ignored by the processor. For example,
the default ``['.#*']`` will ignore emacs lock files. the default ``['.#*']`` will ignore emacs lock files.
@ -108,10 +108,12 @@ Setting name (followed by default value, if any)
include them explicitly and enumerate the full list of include them explicitly and enumerate the full list of
desired Markdown extensions.) desired Markdown extensions.)
``OUTPUT_PATH = 'output/'`` Where to output the generated files. ``OUTPUT_PATH = 'output/'`` Where to output the generated files.
``PATH = None`` Path to content directory to be processed by Pelican. ``PATH`` Path to content directory to be processed by Pelican. If undefined,
``PAGE_DIR = 'pages'`` Directory to look at for pages, relative to `PATH`. and content path is not specified via an argument to the ``pelican``
command, Pelican will use the current working directory.
``PAGE_DIR = 'pages'`` Directory to look at for pages, relative to ``PATH``.
``PAGE_EXCLUDES = ()`` A list of directories to exclude when looking for pages. ``PAGE_EXCLUDES = ()`` A list of directories to exclude when looking for pages.
``ARTICLE_DIR = ''`` Directory to look at for articles, relative to `PATH`. ``ARTICLE_DIR = ''`` Directory to look at for articles, relative to ``PATH``.
``ARTICLE_EXCLUDES = ('pages',)`` A list of directories to exclude when looking for articles. ``ARTICLE_EXCLUDES = ('pages',)`` A list of directories to exclude when looking for articles.
``OUTPUT_SOURCES = False`` Set to True if you want to copy the articles and pages in their ``OUTPUT_SOURCES = False`` Set to True if you want to copy the articles and pages in their
original format (e.g. Markdown or reStructuredText) to the original format (e.g. Markdown or reStructuredText) to the