Settings¶

Basic settings¶

USE_FOLDER_AS_CATEGORY¶

When you don’t specify a category in your post metadata, set this setting to True, and organize your articles in subfolders, the subfolder will become the category of your post. If set to False, DEFAULT_CATEGORY will be used as a fallback. The default is True.

DEFAULT_CATEGORY¶

The default category to fall back on. The default is 'misc'.

DISPLAY_PAGES_ON_MENU¶

Whether to display pages on the menu of the template. Templates may or may not honor this setting. The default is True.

DISPLAY_CATEGORIES_ON_MENU¶

Whether to display categories on the menu of the template. Templates may or not honor this setting. The default is True.

DOCUTILS_SETTINGS¶

Extra configuration settings for the docutils publisher (applicable only to reStructuredText). See Docutils Configuration settings for more details. The default is {} with no extra configuration settings.

DELETE_OUTPUT_DIRECTORY¶

Delete the output directory, and all of its contents, before generating new files. This can be useful in preventing older, unnecessary files from persisting in your output. However, this is a destructive setting and should be handled with extreme care. The default is False.

OUTPUT_RETENTION¶

A list of filenames that should be retained and not deleted from the output directory. One use case would be the preservation of version control data.

Example:

OUTPUT_RETENTION = [".hg", ".git", ".bzr"]

The default is [].

JINJA_ENVIRONMENT¶

A dictionary of custom Jinja2 environment variables you want to use. This also includes a list of extensions you may want to include. See Jinja Environment documentation. The default is {'extensions': [], 'trim_blocks': True, 'lstrip_blocks': True}.

JINJA_FILTERS¶

A dictionary of custom Jinja2 filters you want to use. The dictionary should map the filtername to the filter function.

Example:

importsys
sys.path.append('to/your/path')
fromcustom_filterimport urlencode_filter
JINJA_FILTERS = {'urlencode': urlencode_filter}

See: Jinja custom filters documentation. The default is {}.

JINJA_GLOBALS¶

A dictionary of custom objects to map into the Jinja2 global environment namespace. The dictionary should map the global name to the global variable/function. See: Jinja global namespace documentation. The default is {}.

JINJA_TESTS¶

A dictionary of custom Jinja2 tests you want to use. The dictionary should map test names to test functions. See: Jinja custom tests documentation. The default is {}.

LOG_FILTER¶

A list of tuples containing the logging level (up to warning) and the message to be ignored.

Example:

LOG_FILTER = [(logging.WARN, 'TAG_SAVE_AS is set to False')]

The default is [].

READERS¶

A dictionary of file extensions / Reader classes for Pelican to process or ignore.

For example, to avoid processing .html files, set:

READERS = {'html': None}

To add a custom reader for the foo extension, set:

READERS = {'foo': FooReader}

The default is {}.

IGNORE_FILES¶

A list of Unix glob patterns. Files and directories matching any of these patterns or any of the commonly hidden files and directories set by watchfiles.DefaultFilter will be ignored by the processor. For example, the default ['**/.*'] will ignore "hidden" files and directories, and ['__pycache__'] would ignore Python 3’s bytecode caches.

For a full list of the commonly hidden files set by watchfiles.DefaultFilter, please refer to the watchfiles documentation.

The default is ['**/.*'].

MARKDOWN¶

Extra configuration settings for the Markdown processor. Refer to the Python Markdown documentation’s Options section for a complete list of supported options. The extensions option will be automatically computed from the extension_configs option.

The default is:

MARKDOWN = {
 'extension_configs': {
 'markdown.extensions.codehilite': {'css_class': 'highlight'},
 'markdown.extensions.extra': {},
 'markdown.extensions.meta': {},
 },
 'output_format': 'html5',
}

Note

The dictionary defined in your settings file will replace this default one.

OUTPUT_PATH¶

Where to output the generated files. This should correspond to your web server’s virtual host root directory.

The default is 'output'.

PATH¶

Path to content directory to be processed by Pelican. If undefined, and content path is not specified via an argument to the pelican command, Pelican will default to '.', the current working directory.

PAGE_PATHS¶

A list of directories and files to look at for pages, relative to PATH. The default is ['pages'].

PAGE_EXCLUDES¶

A list of directories to exclude when looking for pages in addition to ARTICLE_PATHS. The default is [].

ARTICLE_PATHS¶

A list of directories and files to look at for articles, relative to PATH. The default is [''].

ARTICLE_EXCLUDES¶

A list of directories to exclude when looking for articles in addition to PAGE_PATHS. The default is [].

OUTPUT_SOURCES¶

Set to True if you want to copy the articles and pages in their original format (e.g. Markdown or reStructuredText) to the specified OUTPUT_PATH. The default is False.

OUTPUT_SOURCES_EXTENSION¶

Controls the extension that will be used by the SourcesGenerator. Defaults to .text. If not a valid string the default value will be used. The default is '.text'.

PLUGINS¶

The list of plugins to load. See Plugins. The default is None.

PLUGIN_PATHS¶

A list of directories where to look for plugins. See Plugins. The default is [].

SITENAME¶

Your site’s name. The default is 'A Pelican Blog'.

SITEURL¶

Base URL of your web site. Not defined by default, so it is best to specify your SITEURL; if you do not, feeds will not be generated with properly-formed URLs. If your site is available via HTTPS, this setting should begin with https:// — otherwise use http://. Then append your domain, with no trailing slash at the end. Example: SITEURL = 'https://example.com'

The default is '', the blank string.

STATIC_PATHS¶

A list of directories (relative to PATH) in which to look for static files. Such files will be copied to the output directory without modification. Articles, pages, and other content source files will normally be skipped, so it is safe for a directory to appear both here and in PAGE_PATHS or ARTICLE_PATHS. Pelican’s default settings include the "images" directory here. The default is ['images'].

STATIC_EXCLUDES¶

A list of directories to exclude when looking for static files. The default is [].

STATIC_EXCLUDE_SOURCES¶

If set to False, content source files will not be skipped when copying files found in STATIC_PATHS. This setting is for backward compatibility with Pelican releases before version 3.5. It has no effect unless STATIC_PATHS contains a directory that is also in ARTICLE_PATHS or PAGE_PATHS. If you are trying to publish your site’s source files, consider using the OUTPUT_SOURCES setting instead. The default is True.

STATIC_CREATE_LINKS¶

Create links instead of copying files. If the content and output directories are on the same device, then create hard links. Falls back to symbolic links if the output directory is on a different filesystem. If symlinks are created, don’t forget to add the -L or --copy-links option to rsync when uploading your site. The default is False.

STATIC_CHECK_IF_MODIFIED¶

If set to True, and STATIC_CREATE_LINKS is False, compare mtimes of content and output files, and only copy content files that are newer than existing output files. The default is False.

TYPOGRIFY¶

If set to True, several typographical improvements will be incorporated into the generated HTML via the Typogrify library, which can be installed via: python -m pip install typogrify. The default is False.

TYPOGRIFY_IGNORE_TAGS¶

A list of tags for Typogrify to ignore. By default Typogrify will ignore pre and code tags. This requires that Typogrify version 2.0.4 or later is installed. The default is [].

TYPOGRIFY_OMIT_FILTERS¶

A list of Typogrify filters to skip. Allowed values are: 'amp', 'smartypants', 'caps', 'initial_quotes', 'widont'. By default, no filter is omitted (in other words, all filters get applied). This setting requires that Typogrify version 2.1.0 or later is installed. The default is [].

TYPOGRIFY_DASHES¶

This setting controls how Typogrify sets up the Smartypants filter to interpret multiple dash/hyphen/minus characters. A single ASCII dash character (-) is always rendered as a hyphen. The default setting does not handle en-dashes and converts double-hyphens into em-dashes. The oldschool setting renders both en-dashes and em-dashes when it sees two (--) and three (---) hyphen characters, respectively. The oldschool_inverted setting turns two hyphens into an em-dash and three hyphens into an en-dash. The default is 'default'.

SUMMARY_MAX_LENGTH¶

When creating a short summary of an article, this will be the default length (measured in words) of the text created. This only applies if your content does not otherwise specify a summary. Setting to None will cause the summary to be a copy of the original content. The default is 50.

SUMMARY_MAX_PARAGRAPHS¶

When creating a short summary of an article, this will be the number of paragraphs to use as the summary. This only applies if your content does not otherwise specify a summary. Setting to None will cause the summary to use the whole text (up to SUMMARY_MAX_LENGTH) instead of just the first N paragraphs. The default is None.

SUMMARY_END_SUFFIX¶

When creating a short summary of an article and the result was truncated to match the required word length, this will be used as the truncation suffix. The default is '...'.

WITH_FUTURE_DATES¶

If disabled, content with dates in the future will get a default status of draft. See Reading only modified content for caveats. The default is True.

INTRASITE_LINK_REGEX¶

Regular expression that is used to parse internal links. Default syntax when linking to internal files, tags, etc., is to enclose the identifier, say filename, in {} or ||. Identifier between { and } goes into the what capturing group. For details see Linking to internal content. The default is '[{|](?P<what>.*?)[|}]'.

PYGMENTS_RST_OPTIONS¶

A list of default Pygments settings for your reStructuredText code blocks. See Syntax highlighting for a list of supported options. The default is {}.

CACHE_CONTENT¶

If True, saves content in caches. See Reading only modified content for details about caching. The default is False.

CONTENT_CACHING_LAYER¶

If set to 'reader', save only the raw content and metadata returned by readers. If set to 'generator', save processed content objects. The default is 'reader'.

CACHE_PATH¶

Directory in which to store cache files. The default is 'cache'.

GZIP_CACHE¶

If True, use gzip to (de)compress the cache files. The default is True.

CHECK_MODIFIED_METHOD¶

Controls how files are checked for modifications.

• If set to 'mtime', the modification time of the file is checked.

• If set to a name of a function provided by the hashlib module, e.g. 'md5', the file hash is checked.

The default is 'mtime'.

LOAD_CONTENT_CACHE¶

If True, load unmodified content from caches. The default is False.

FORMATTED_FIELDS¶

A list of metadata fields containing reST/Markdown content to be parsed and translated to HTML. The default is ['summary'].

PORT¶

The TCP port to serve content from the output folder via HTTP when pelican is run with --listen. The default is 8000.

BIND¶

The IP to which to bind the HTTP server. The default is '127.0.0.1'.

URL settings¶

The first thing to understand is that there are currently two supported methods for URL formation: relative and absolute. Relative URLs are useful when testing locally, and absolute URLs are reliable and most useful when publishing. One method of supporting both is to have one Pelican configuration file for local development and another for publishing. To see an example of this type of setup, use the pelican-quickstart script as described in the Installation section, which will produce two separate configuration files for local development and publishing, respectively.

You can customize the URLs and locations where files will be saved. The *_URL and *_SAVE_AS variables use Python’s format strings. These variables allow you to place your articles in a location such as {slug}/index.html and link to them as {slug} for clean URLs (see example below). These settings give you the flexibility to place your articles and pages anywhere you want.

If you don’t want that flexibility and instead prefer that your generated output paths mirror your source content’s filesystem path hierarchy, try the following settings:

PATH_METADATA = r'(?P<path_no_ext>.*)\..*'
ARTICLE_URL = ARTICLE_SAVE_AS = PAGE_URL = PAGE_SAVE_AS = '{path_no_ext}.html'

Otherwise, you can use a variety of file metadata attributes within URL-related settings:

• slug

• date

• lang

• author

• category

Example usage:

ARTICLE_URL = 'posts/{date:%Y}/{date:%b}/{date:%d}/{slug}/'
ARTICLE_SAVE_AS = 'posts/{date:%Y}/{date:%b}/{date:%d}/{slug}/index.html'
PAGE_URL = 'pages/{slug}/'
PAGE_SAVE_AS = 'pages/{slug}/index.html'

This would save your articles into something like /posts/2011/Aug/07/sample-post/index.html, save your pages into /pages/about/index.html, and render them available at URLs of /posts/2011/Aug/07/sample-post/ and /pages/about/, respectively.

RELATIVE_URLS¶

Defines whether Pelican should use document-relative URLs or not. Only set this to True when developing/testing and only if you fully understand the effect it can have on links/feeds. The default is False.

ARTICLE_URL¶

The URL to refer to an article. The default is '{slug}.html'.

ARTICLE_SAVE_AS¶

The place where we will save an article. The default is '{slug}.html'.

ARTICLE_LANG_URL¶

The URL to refer to an article which doesn’t use the default language. The default is '{slug}-{lang}.html.

ARTICLE_LANG_SAVE_AS¶

The place where we will save an article which doesn’t use the default language. The default is '{slug}-{lang}.html'.

DRAFT_URL¶

The URL to refer to an article draft. The default is 'drafts/{slug}.html'.

DRAFT_SAVE_AS¶

The place where we will save an article draft. The default is 'drafts/{slug}.html'.

DRAFT_LANG_URL¶

The URL to refer to an article draft which doesn’t use the default language. The default is 'drafts/{slug}-{lang}.html'.

DRAFT_LANG_SAVE_AS¶

The place where we will save an article draft which doesn’t use the default language. The default is 'drafts/{slug}-{lang}.html'.

PAGE_URL¶

The URL we will use to link to a page. The default is 'pages/{slug}.html'.

PAGE_SAVE_AS¶

The location we will save the page. This value has to be the same as PAGE_URL or you need to use a rewrite in your server config. The default is 'pages/{slug}.html'.

PAGE_LANG_URL¶

The URL we will use to link to a page which doesn’t use the default language. The default is 'pages/{slug}-{lang}.html'.

PAGE_LANG_SAVE_AS¶

The location we will save the page which doesn’t use the default language. The default is 'pages/{slug}-{lang}.html'.

DRAFT_PAGE_URL¶

The URL used to link to a page draft. The default is 'drafts/pages/{slug}.html'.

DRAFT_PAGE_SAVE_AS¶

The actual location a page draft is saved at. The default is 'drafts/pages/{slug}.html'.

DRAFT_PAGE_LANG_URL¶

The URL used to link to a page draft which doesn’t use the default language. The default is 'drafts/pages/{slug}-{lang}.html'.

DRAFT_PAGE_LANG_SAVE_AS¶

The actual location a page draft which doesn’t use the default language is saved at. The default is 'drafts/pages/{slug}-{lang}.html'.

AUTHOR_URL¶

The URL to use for an author. The default is 'author/{slug}.html'.

AUTHOR_SAVE_AS¶

The location to save an author. The default is 'author/{slug}.html'.

CATEGORY_URL¶

The URL to use for a category. The default is 'category/{slug}.html'.

CATEGORY_SAVE_AS¶

The location to save a category. The default is 'category/{slug}.html'.

TAG_URL¶

The URL to use for a tag. The default is 'tag/{slug}.html'.

TAG_SAVE_AS¶

The location to save the tag page. The default is 'tag/{slug}.html'.

Pelican can optionally create per-year, per-month, and per-day archives of your posts. These secondary archives are disabled by default but are automatically enabled if you supply format strings for their respective _SAVE_AS settings. Period archives fit intuitively with the hierarchical model of web URLs and can make it easier for readers to navigate through the posts you’ve written over time.

Example usage:

YEAR_ARCHIVE_SAVE_AS = 'posts/{date:%Y}/index.html'
YEAR_ARCHIVE_URL = 'posts/{date:%Y}/'
MONTH_ARCHIVE_SAVE_AS = 'posts/{date:%Y}/{date:%b}/index.html'
MONTH_ARCHIVE_URL = 'posts/{date:%Y}/{date:%b}/'

With these settings, Pelican will create an archive of all your posts for the year at (for instance) posts/2011/index.html and an archive of all your posts for the month at posts/2011/Aug/index.html. These can be accessed through the URLs posts/2011/ and posts/2011/Aug/, respectively.

YEAR_ARCHIVE_SAVE_AS¶

The location to save per-year archives of your posts. The default is ''.

YEAR_ARCHIVE_URL¶

The URL to use for per-year archives of your posts. You should set this if you enable per-year archives. The default is ''.

MONTH_ARCHIVE_SAVE_AS¶

The location to save per-month archives of your posts. The default is ''.

MONTH_ARCHIVE_URL¶

The URL to use for per-month archives of your posts. You should set this if you enable per-month archives. The default is ''.

DAY_ARCHIVE_SAVE_AS¶

The location to save per-day archives of your posts. The default is ''.

DAY_ARCHIVE_URL¶

The URL to use for per-day archives of your posts. You should set this if you enable per-day archives. The default is ''.

DIRECT_TEMPLATES work a bit differently than noted above. Only the _SAVE_AS settings are available, but it is available for any direct template.

ARCHIVES_SAVE_AS¶

The location to save the article archives page. The default is 'archives.html'.

AUTHORS_SAVE_AS¶

The location to save the author list. The default is 'authors.html'.

CATEGORIES_SAVE_AS¶

The location to save the category list. The default is 'categories.html'.

TAGS_SAVE_AS¶

The location to save the tag list. The default is 'tags.html'.

INDEX_SAVE_AS¶

The location to save the list of all articles. The default is 'index.html'.

URLs for direct template pages are theme-dependent. Some themes use corresponding *_URL setting as string, while others hard-code them: 'archives.html', 'authors.html', 'categories.html', 'tags.html'.

SLUGIFY_SOURCE¶

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 article’s file name when creating the slug. The default is 'title'.

SLUGIFY_USE_UNICODE¶

Allow Unicode characters in slugs. Set True to keep Unicode characters in auto-generated slugs. Otherwise, Unicode characters will be replaced with ASCII equivalents. The default is False.

SLUGIFY_PRESERVE_CASE¶

Preserve uppercase characters in slugs. Set True to keep uppercase characters from SLUGIFY_SOURCE as-is. The default is False.

SLUG_REGEX_SUBSTITUTIONS¶

Regex substitutions to make when generating slugs of articles and pages. Specified as a list of pairs of (from, to) which are applied in order, ignoring case. The default substitutions have the effect of removing non-alphanumeric characters and converting internal whitespace to dashes. Apart from these substitutions, slugs are always converted to lowercase ascii characters and leading and trailing whitespace is stripped. Useful for backward compatibility with existing URLs. The default is:

[
 (r'[^\w\s-]', ''), # remove non-alphabetical/whitespace/'-' chars
 (r'(?u)\A\s*', ''), # strip leading whitespace
 (r'(?u)\s*\Z', ''), # strip trailing whitespace
 (r'[-\s]+', '-'), # reduce multiple whitespace or '-' to single '-'
]

AUTHOR_REGEX_SUBSTITUTIONS¶

Regex substitutions for author slugs. The default is SLUG_REGEX_SUBSTITUTIONS.

CATEGORY_REGEX_SUBSTITUTIONS¶

Regex substitutions for category slugs. The default is SLUG_REGEX_SUBSTITUTIONS.

TAG_REGEX_SUBSTITUTIONS¶

Regex substitutions for tag slugs. The default is SLUG_REGEX_SUBSTITUTIONS.

Time and Date¶

TIMEZONE¶

The timezone used in the date information, to generate Atom and RSS feeds.

If no timezone is defined, UTC is assumed. This means that the generated Atom and RSS feeds will contain incorrect date information if your locale is not UTC.

Pelican issues a warning in case this setting is not defined, as it was not mandatory in previous versions.

Have a look at the wikipedia page to get a list of valid timezone values.

DEFAULT_DATE¶

The default date you want to use. If 'fs', Pelican will use the file system timestamp information (mtime) if it can’t get date information from the metadata. If given any other string, it will be parsed by the same method as article metadata. If set to a tuple object, the default datetime object will instead be generated by passing the tuple to the datetime.datetime constructor. The default is None.

DEFAULT_DATE_FORMAT¶

The default date format you want to use. The default is '%a %d %B %Y'.

DATE_FORMATS¶

If you manage multiple languages, you can set the date formatting here.

If no DATE_FORMATS are set, Pelican will fall back to DEFAULT_DATE_FORMAT. If you need to maintain multiple languages with different date formats, you can set the DATE_FORMATS dictionary using the language name (lang metadata in your post content) as the key.

In addition to the standard C89 strftime format codes that are listed in Python datetime documentation, you can use the - character between % and the format character to remove any leading zeros. For example, %d/%m/%Y will output 01/01/2014 whereas %-d/%-m/%Y will result in 1/1/2014.

DATE_FORMATS = {
 'en': '%a, %d %b %Y',
 'jp': '%Y-%m-%d(%a)',
}

It is also possible to set different locale settings for each language by using a (locale, format) tuple as a dictionary value which will override the LOCALE setting:

# On Unix/Linux
DATE_FORMATS = {
 'en': ('en_US','%a, %d %b %Y'),
 'jp': ('ja_JP','%Y-%m-%d(%a)'),
}
# On Windows
DATE_FORMATS = {
 'en': ('usa','%a, %d %b %Y'),
 'jp': ('jpn','%Y-%m-%d(%a)'),
}

The default is {}.

LOCALE¶

Change the locale. A list of locales can be provided here or a single string representing one locale. When providing a list, all the locales will be tried until one works.

You can set locale to further control date format:

LOCALE = ['usa', 'jpn', # On Windows
 'en_US', 'ja_JP' # On Unix/Linux
]

For a list of available locales refer to locales on Windows or on Unix/Linux, use the locale -a command; see manpage locale(1) for more information. The default is the system locale.

Template pages¶

TEMPLATE_PAGES¶

A mapping containing template pages that will be rendered with the blog entries.

If you want to generate custom pages besides your blog entries, you can point any Jinja2 template file with a path pointing to the file and the destination path for the generated file.

For instance, if you have a blog with three static pages — a list of books, your resume, and a contact page — you could have:

TEMPLATE_PAGES = {'src/books.html': 'dest/books.html',
 'src/resume.html': 'dest/resume.html',
 'src/contact.html': 'dest/contact.html'}

The default is {}.

TEMPLATE_EXTENSIONS¶

The extensions to use when looking up template files from template names. The default is ['.html'].

DIRECT_TEMPLATES¶

List of templates that are used directly to render content. Typically direct templates are used to generate index pages for collections of content (e.g., category and tag index pages). If the author, category and tag collections are not needed, set DIRECT_TEMPLATES = ['index', 'archives']

DIRECT_TEMPLATES are searched for over paths maintained in THEME_TEMPLATES_OVERRIDES.

The default is ['index', 'tags', 'categories', 'authors', 'archives'].

Metadata¶

AUTHOR¶

Default author (usually your name). The default is None, which removes the byline.

DEFAULT_METADATA¶

The default metadata you want to use for all articles and pages. The default is {}.

FILENAME_METADATA¶

The regexp that will be used to extract any metadata from the filename. All named groups that are matched will be set in the metadata object. The default value will only extract the date from the filename.

For example, to extract both the date and the slug:

FILENAME_METADATA = r'(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'

See also SLUGIFY_SOURCE. The default is r'(?P<date>\d{4}-\d{2}-\d{2}).*'.

PATH_METADATA¶

Like FILENAME_METADATA, but parsed from a page’s full path relative to the content source directory. The default is ''.

EXTRA_PATH_METADATA¶

Extra metadata dictionaries keyed by relative path. Relative paths require correct OS-specific directory separators (i.e. / in UNIX and \ in Windows) unlike some other Pelican file settings. Paths to a directory apply to all files under it. The most-specific path wins conflicts.

Not all metadata needs to be embedded in source file itself. For example, blog posts are often named following a YYYY-MM-DD-SLUG.rst pattern, or nested into YYYY/MM/DD-SLUG directories. To extract metadata from the filename or path, set FILENAME_METADATA or PATH_METADATA to regular expressions that use Python’s group name notation (?P<name>...). If you want to attach additional metadata but don’t want to encode it in the path, you can set EXTRA_PATH_METADATA:

EXTRA_PATH_METADATA = {
 'relative/path/to/file-1': {
 'key-1a': 'value-1a',
 'key-1b': 'value-1b',
 },
 'relative/path/to/file-2': {
 'key-2': 'value-2',
 },
 }

This can be a convenient way to shift the installed location of a particular file:

# Take advantage of the following defaults
# STATIC_SAVE_AS = '{path}'
# STATIC_URL = '{path}'
STATIC_PATHS = [
 'static/robots.txt',
 ]
EXTRA_PATH_METADATA = {
 'static/robots.txt': {'path': 'robots.txt'},
 }

The default is {}.

Feed settings¶

By default, Pelican uses Atom feeds. However, it is also possible to use RSS feeds if you prefer.

Pelican generates category feeds as well as feeds for all your articles. It does not generate feeds for tags by default, but it is possible to do so using the TAG_FEED_ATOM and TAG_FEED_RSS settings:

FEED_DOMAIN¶

The domain prepended to feed URLs. Since feed URLs should always be absolute, it is highly recommended to define this (e.g., "https://feeds.example.com"). The default is SITEURL.

FEED_ATOM¶

The location to save the Atom feed. The default is None, for no Atom feed.

FEED_ATOM_URL¶

Relative URL of the Atom feed. If not set, FEED_ATOM is used both for save location and URL. The default is None.

FEED_RSS¶

The location to save the RSS feed. The default is None, for no RSS feed.

FEED_RSS_URL¶

Relative URL of the RSS feed. If not set, FEED_RSS is used both for save location and URL. The default is None.

FEED_ALL_ATOM¶

The location to save the all-posts Atom feed: this feed will contain all posts regardless of their language. The default is 'feeds/all.atom.xml'.

FEED_ALL_ATOM_URL¶

Relative URL of the all-posts Atom feed. If not set, FEED_ALL_ATOM is used both for save location and URL. The default is None.

FEED_ALL_RSS¶

The location to save the the all-posts RSS feed: this feed will contain all posts regardless of their language. The default is None, for no all-posts RSS feed.

FEED_ALL_RSS_URL¶

Relative URL of the all-posts RSS feed. If not set, FEED_ALL_RSS is used both for save location and URL. The default is None.

CATEGORY_FEED_ATOM¶

The location to save the category Atom feeds. [2] The default is 'feeds/{slug}.atom.xml'.

CATEGORY_FEED_ATOM_URL¶

Relative URL of the category Atom feeds, including the {slug} placeholder. [2] If not set, CATEGORY_FEED_ATOM is used both for save location and URL. The default is None.

CATEGORY_FEED_RSS¶

The location to save the category RSS feeds, including the {slug} placeholder. [2] The default is None, for no RSS feed.

CATEGORY_FEED_RSS_URL¶

Relative URL of the category RSS feeds, including the {slug} placeholder. [2] If not set, CATEGORY_FEED_RSS is used both for save location and URL. The default is None.

AUTHOR_FEED_ATOM¶

The location to save the author Atom feeds. [2] The default is 'feeds/{slug}.atom.xml'.

AUTHOR_FEED_ATOM_URL¶

Relative URL of the author Atom feeds, including the {slug} placeholder. [2] If not set, AUTHOR_FEED_ATOM is used both for save location and URL. The default is None (not set).

AUTHOR_FEED_RSS¶

The location to save the author RSS feeds. [2] The default is 'feeds/{slug}.rss.xml'.

AUTHOR_FEED_RSS_URL¶

Relative URL of the author RSS feeds, including the {slug} placeholder. [2] If not set, AUTHOR_FEED_RSS is used both for save location and URL. The default is None.

TAG_FEED_ATOM¶

The location to save the tag Atom feed, including the {slug} placeholder. [2] The default is None, for no tag feed.

TAG_FEED_ATOM_URL¶

Relative URL of the tag Atom feed, including the {slug} placeholder. [2] The default is None.

TAG_FEED_RSS¶

Relative URL to output the tag RSS feed, including the {slug} placeholder. If not set, TAG_FEED_RSS is used both for save location and URL. The default is None, for no tag feed.

FEED_MAX_ITEMS¶

Maximum number of items allowed in a feed. Setting to None will cause the feed to contains every article. 100 if not specified. The default is 100.

RSS_FEED_SUMMARY_ONLY¶

Only include item summaries in the description tag of RSS feeds. If set to False, the full content will be included instead. This setting doesn’t affect Atom feeds, only RSS ones. The default is True.

FEED_APPEND_REF¶

If set to True, ?ref=feed will be appended to links in generated feeds for the purpose of referrer tracking. The default is False.

If you don’t want to generate some or any of these feeds, set the above variables to None.

Pagination¶

The default behaviour of Pelican is to list all the article titles along with a short description on the index page. While this works well for small-to-medium sites, sites with a large quantity of articles will probably benefit from paginating this list.

You can use the following settings to configure the pagination.

DEFAULT_ORPHANS¶

The minimum number of articles allowed on the last page. Use this when you don’t want the last page to only contain a handful of articles. The default is 0.

DEFAULT_PAGINATION¶

The maximum number of articles to include on a page, not including orphans. False to disable pagination. The default is False.

PAGINATED_TEMPLATES¶

The templates to use pagination with, and the number of articles to include on a page. If this value is None, it defaults to DEFAULT_PAGINATION. The default is {'index': None, 'tag': None, 'category': None, 'author': None}.

PAGINATION_PATTERNS¶

A set of patterns that are used to determine advanced pagination output. The default is:

(
 (1, '{name}{extension}', '{name}{extension}'),
 (2, '{name}{number}{extension}', '{name}{number}{extension}'),
)

(minimum_page, page_url, page_save_as,)

PAGINATION_PATTERNS = (
 (1, '{url}', '{save_as}'),
 (2, '{base_name}/page/{number}/', '{base_name}/page/{number}/index.html'),
)

(-1, '{base_name}/last/', '{base_name}/last/index.html'),

Translations¶

Pelican offers a way to translate articles. See the Content section for more information.

DEFAULT_LANG¶

The default language to use. The default is 'en'.

ARTICLE_TRANSLATION_ID¶

The metadata attribute(s) used to identify which articles are translations of one another. May be a string or a collection of strings. Set to None or False to disable the identification of translations. The default is 'slug'.

PAGE_TRANSLATION_ID¶

The metadata attribute(s) used to identify which pages are translations of one another. May be a string or a collection of strings. Set to None or False to disable the identification of translations. The default is 'slug'.

TRANSLATION_FEED_ATOM¶

The location to save the Atom feed for translations. [3] The default is 'feeds/all-{lang}.atom.xml'.

TRANSLATION_FEED_ATOM_URL¶

Relative URL of the Atom feed for translations, including the {lang} placeholder. [3] If not set, TRANSLATION_FEED_ATOM is used both for save location and URL. The default is None.

TRANSLATION_FEED_RSS¶

Where to put the RSS feed for translations. The default is None, meaning no RSS feed.

TRANSLATION_FEED_RSS_URL¶

Relative URL of the RSS feed for translations, including the {lang} placeholder. [3] If not set, TRANSLATION_FEED_RSS is used both for save location and URL. The default is None.

Ordering content¶

NEWEST_FIRST_ARCHIVES¶

Order archives by newest first by date. (False: orders by date with older articles first.) The default is True.

REVERSE_CATEGORY_ORDER¶

Reverse the category order. (True: lists by reverse alphabetical order; default lists alphabetically.) The default is False.

ARTICLE_ORDER_BY¶

Defines how the articles (articles_page.object_list in the template) are sorted. Valid options are: metadata as a string (use reversed- prefix to reverse the sort order), special option 'basename' which will use the basename of the file (without path), or a custom function to extract the sorting key from articles. Using a value of 'date' will sort articles in chronological order, while the default value, 'reversed-date', will sort articles by date in reverse order (i.e., newest article comes first). The default is 'reversed-date'.

PAGE_ORDER_BY¶

Defines how the pages (pages variable in the template) are sorted. Options are same as ARTICLE_ORDER_BY. The default value, 'basename' will sort pages by their basename. The default is 'basename'.

Themes¶

Creating Pelican themes is addressed in a dedicated section (see Themes). However, here are the settings that are related to themes.

THEME¶

Theme to use to produce the output. Can be a relative or absolute path to a theme folder, or the name of a default theme or a theme installed via pelican-themes (see below). The default theme is "notmyidea".

THEME_STATIC_DIR¶

Destination directory in the output path where Pelican will place the files collected from THEME_STATIC_PATHS. Default is theme. The default is 'theme'.

THEME_STATIC_PATHS¶

Static theme paths you want to copy. Default value is static, but if your theme has other static paths, you can put them here. If files or directories with the same names are included in the paths defined in this settings, they will be progressively overwritten. The default is ['static'].

THEME_TEMPLATES_OVERRIDES¶

A list of paths you want Jinja2 to search for templates before searching the theme’s templates/ directory. Allows for overriding individual theme template files without having to fork an existing theme. Jinja2 searches in the following order: files in THEME_TEMPLATES_OVERRIDES first, then the theme’s templates/. The default is [].

You can also extend templates from the theme using the {% extends %} directive utilizing the !theme prefix as shown in the following example:

{% extends '!theme/article.html' %}

CSS_FILE¶

Specify the CSS file you want to load. The default is 'main.css'.

By default, two themes are available. You can specify them using the THEME setting or by passing the -t option to the pelican command:

• notmyidea

• simple (a synonym for "plain text" :)

There are a number of other themes available at https://github.com/getpelican/pelican-themes. Pelican comes with pelican-themes, a small script for managing themes.

You can define your own theme, either by starting from scratch or by duplicating and modifying a pre-existing theme. Here is a guide on how to create your theme.

Following are example ways to specify your preferred theme:

# Specify name of a built-in theme
THEME = "notmyidea"
# Specify name of a theme installed via the pelican-themes tool
THEME = "chunk"
# Specify a customized theme, via path relative to the settings file
THEME = "themes/mycustomtheme"
# Specify a customized theme, via absolute path
THEME = "/home/myuser/projects/mysite/themes/mycustomtheme"

The built-in simple theme can be customized using the following settings.

STYLESHEET_URL¶

The URL of the stylesheet to use. The default is None.

The built-in notmyidea theme can make good use of the following settings. Feel free to use them in your themes as well.

SITESUBTITLE¶

A subtitle to appear in the header. The default is None.

DISQUS_SITENAME¶

Pelican can handle Disqus comments. Specify the Disqus sitename identifier here. The default is None.

GITHUB_URL¶

Your GitHub URL (if you have one). It will then use this information to create a GitHub ribbon. The default is None.

ANALYTICS¶

Put any desired analytics scripts in this setting in publishconf.py. Example:

ANALYTICS = """
 <script src="/theme/js/primary-analytics.js"></script>
 <script>
 [ ... in-line Javascript code for secondary analytics ... ]
 </script>
"""

The default is None.

MENUITEMS¶

A list of tuples (Title, URL) for additional menu items to appear at the beginning of the main menu. The default is None.

LINKS¶

A list of tuples (Title, URL) for links to appear on the header. The default is None.

SOCIAL¶

A list of tuples (Title, URL) to appear in the "social" section. The default is None.

TWITTER_USERNAME¶

Allows for adding a button to articles to encourage others to tweet about them. Add your Twitter username if you want this button to appear. The default is None.

LINKS_WIDGET_NAME¶

Allows override of the name of the links widget. If not specified, defaults to "links". The default is None.

SOCIAL_WIDGET_NAME¶

Allows override of the name of the "social" widget. If not specified, defaults to "social". The default is None.

In addition, you can use the "wide" version of the notmyidea theme by adding the following to your configuration:

CSS_FILE = "wide.css"

Logging¶

Sometimes, a long list of warnings may appear during site generation. Finding the meaningful error message in the middle of tons of annoying log output can be quite tricky. In order to filter out redundant log messages, Pelican comes with the LOG_FILTER setting.

LOG_FILTER should be a list of tuples (level, msg), each of them being composed of the logging level (up to warning) and the message to be ignored. Simply populate the list with the log messages you want to hide, and they will be filtered out.

For example:

importlogging
LOG_FILTER = [(logging.WARN, 'TAG_SAVE_AS is set to False')]

It is possible to filter out messages by a template. Check out source code to obtain a template.

For example:

importlogging
LOG_FILTER = [(logging.WARN, 'Empty alt attribute for image %s in %s')]

Reading only modified content¶

To speed up the build process, Pelican can optionally read only articles and pages with modified content.

When Pelican is about to read some content source file:

1. The hash or modification time information for the file from a previous build are loaded from a cache file if LOAD_CONTENT_CACHE is True. These files are stored in the CACHE_PATH directory. If the file has no record in the cache file, it is read as usual.

2. The file is checked according to CHECK_MODIFIED_METHOD:

   • If set to 'mtime', the modification time of the file is checked.

   • If set to a name of a function provided by the hashlib module, e.g. 'md5', the file hash is checked.

   • If set to anything else or the necessary information about the file cannot be found in the cache file, the content is read as usual.

3. If the file is considered unchanged, the content data saved in a previous build corresponding to the file is loaded from the cache, and the file is not read.

4. If the file is considered changed, the file is read and the new modification information and the content data are saved to the cache if CACHE_CONTENT is True.

If CONTENT_CACHING_LAYER is set to 'reader' (the default), the raw content and metadata returned by a reader are cached. If this setting is instead set to 'generator', the processed content object is cached. Caching the processed content object may conflict with plugins (as some reading related signals may be skipped) and the WITH_FUTURE_DATES functionality (as the draft status of the cached content objects would not change automatically over time).

Checking modification times is faster than comparing file hashes, but it is not as reliable because mtime information can be lost, e.g., when copying content source files using the cp or rsync commands without the mtime preservation mode (which for rsync can be invoked by passing the --archive flag).

The cache files are Python pickles, so they may not be readable by different versions of Python as the pickle format often changes. If such an error is encountered, it is caught and the cache file is rebuilt automatically in the new format. The cache files will also be rebuilt after the GZIP_CACHE setting has been changed.

The --ignore-cache command-line option is useful when the whole cache needs to be regenerated, such as when making modifications to the settings file that will affect the cached content, or just for debugging purposes. When Pelican runs in autoreload mode, modification of the settings file will make it ignore the cache automatically if AUTORELOAD_IGNORE_CACHE is True.

Note that even when using cached content, all output is always written, so the modification times of the generated *.html files will always change. Therefore, rsync-based uploading may benefit from the --checksum option.

Example settings¶

AUTHOR = "Alexis Métaireau"
SITENAME = "Alexis' log"
SITESUBTITLE = "A personal blog."
SITEURL = "http://blog.notmyidea.org"
TIMEZONE = "Europe/Paris"
# can be useful in development, but set to False when you're ready to publish
RELATIVE_URLS = True
GITHUB_URL = "http://github.com/ametaireau/"
DISQUS_SITENAME = "blog-notmyidea"
REVERSE_CATEGORY_ORDER = True
LOCALE = "C"
DEFAULT_PAGINATION = 4
DEFAULT_DATE = (2012, 3, 2, 14, 1, 1)
FEED_ALL_RSS = "feeds/all.rss.xml"
CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml"
LINKS = [
 ("Biologeek", "http://biologeek.org"),
 ("Filyb", "http://filyb.info/"),
 ("Libert-fr", "http://www.libert-fr.com"),
 ("N1k0", "http://prendreuncafe.com/blog/"),
 ("Tarek Ziadé", "http://ziade.org/blog"),
 ("Zubin Mithra", "http://zubin71.wordpress.com/"),
]
SOCIAL = [
 ("twitter", "http://twitter.com/ametaireau"),
 ("lastfm", "http://lastfm.com/user/akounet"),
 ("github", "http://github.com/ametaireau"),
]
# global metadata to all the contents
DEFAULT_METADATA = {"yeah": "it is"}
# path-specific metadata
EXTRA_PATH_METADATA = {
 "extra/robots.txt": {"path": "robots.txt"},
}
# static paths will be copied without parsing their contents
STATIC_PATHS = [
 "images",
 "extra/robots.txt",
]
# custom page generated with a jinja2 template
TEMPLATE_PAGES = {"pages/jinja2_template.html": "jinja2_template.html"}
# there is no other HTML content
READERS = {"html": None}
# code blocks with line numbers
PYGMENTS_RST_OPTIONS = {"linenos": "table"}
# foobar will not be used, because it's not in caps. All configuration keys
# have to be in caps
foobar = "barbaz"