pelican

Static site generator that supports Markdown and reST syntax. Powered by Python.

13,289 stars Python #pelican#python#static-site-generator
RAW Doc

File: docs/content.rst

Writing content
###############

Articles and pages

Pelican considers "articles" to be chronological content, such as posts on a
blog, and thus associated with a date.

The idea behind "pages" is that they are usually not temporal in nature and are
used for content that does not change very often (e.g., "About" or "Contact"
pages).

You can find sample content in the repository at samples/content/.

.. _internal_metadata:

File metadata

Pelican tries to be smart enough to get the information it needs from the
file system (for instance, about the category of your articles), but some
information you need to provide in the form of metadata inside your files.

If you are writing your content in reStructuredText format, you can provide
this metadata in text files via the following syntax (give your file the
.rst extension)::

text
My super title
##############

:date: 2010-10-03 10:20
:modified: 2010-10-04 18:40
:tags: thats, awesome
:category: yeah
:slug: my-super-post
:authors: Alexis Metaireau, Conan Doyle
:summary: Short version for index and feeds

Author and tag lists may be semicolon-separated instead, which allows
you to write authors and tags containing commas::

text
:tags: pelican, publishing tool; pelican, bird
:authors: Metaireau, Alexis; Doyle, Conan

Pelican implements an extension to reStructuredText to enable support for the
abbr HTML tag. To use it, write something like this in your post::

text
This will be turned into :abbr:`HTML (HyperText Markup Language)`.

You can also use Markdown syntax (with a file ending in .md, .markdown,
.mkd, or .mdown). Markdown generation requires that you first
explicitly install the Python-Markdown_ package, which can be done via pip install Markdown.

Pelican also supports Markdown Extensions_, which might have to be installed
separately if they are not included in the default Markdown package and can
be configured and loaded via the MARKDOWN setting.

Metadata syntax for Markdown posts should follow this pattern::

text
Title: My super title
Date: 2010-12-03 10:20
Modified: 2010-12-05 19:30
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Authors: Alexis Metaireau, Conan Doyle
Summary: Short version for index and feeds

This is the content of my super blog post.

You can also have your own metadata keys (so long as they don't conflict with
reserved metadata keywords) for use in your templates. The following table
contains a list of reserved metadata keywords:

=============== ===============================================================
Metadata Description
=============== ===============================================================
title Title of the article or page
date Publication date (e.g., YYYY-MM-DD HH:SS)
modified Modification date (e.g., YYYY-MM-DD HH:SS)
tags Content tags, separated by commas
keywords Content keywords, separated by commas (HTML content only)
category Content category (one only — not multiple)
slug Identifier used in URLs and translations
author Content author, when there is only one
authors Content authors, when there are multiple
summary Brief description of content for index pages
lang Content language ID (en, fr, etc.)
translation If content is a translation of another (true or false)
status Content status: draft, hidden, skip, or published
template Name of template to use to generate content (without extension)
save_as Save content to this relative file path
url URL to use for this article/page
=============== ===============================================================

Readers for additional formats (such as AsciiDoc_) are available via plugins,
which you can find via the Pelican Plugins_ collection as well as the legacy
pelican-plugins_ repository.

Pelican can also process HTML files ending in .html and .htm. Pelican
interprets the HTML in a very straightforward manner, reading metadata from
meta tags, the title from the title tag, and the body out from the
body tag::

text
<html>
    <head>
        <title>My super title</title>
        <meta name="tags" content="thats, awesome" />
        <meta name="date" content="2012-07-09 22:28" />
        <meta name="modified" content="2012-07-10 20:14" />
        <meta name="category" content="yeah" />
        <meta name="authors" content="Alexis Métaireau, Conan Doyle" />
        <meta name="summary" content="Short version for index and feeds" />
    </head>
    
        This is the content of my super blog post.
    
</html>

With HTML, there is one simple exception to the standard metadata: tags can be
specified either via the tags metadata, as is standard in Pelican, or via
the keywords metadata, as is standard in HTML. The two can be used
interchangeably.

Note that, aside from the title, none of this content metadata is mandatory:
if the date is not specified and DEFAULT_DATE is set to 'fs', Pelican
will rely on the file's "mtime" timestamp, and the category can be determined
by the directory in which the file resides. For example, a file located at
python/foobar/myfoobar.rst will have a category of foobar. If you would
like to organize your files in other ways where the name of the subfolder would
not be a good category name, you can set the setting USE_FOLDER_AS_CATEGORY
to False. When parsing dates given in the page metadata, Pelican supports
the W3C's suggested subset ISO 8601__.

So the title is the only required metadata. If that bothers you, worry not.
Instead of manually specifying a title in your metadata each time, you can use
the source content file name as the title. For example, a Markdown source file
named Publishing via Pelican.md would automatically be assigned a title of
Publishing via Pelican. If you would prefer this behavior, add the following
line to your settings file::

text
FILENAME_METADATA = '(?P<title>.*)'

.. note::

When experimenting with different settings (especially the metadata
ones) caching may interfere and the changes may not be visible. In
such cases disable caching with LOAD_CONTENT_CACHE = False or
use the --ignore-cache command-line switch.

__ W3C ISO 8601_

modified should be last time you updated the article, and defaults to
date if not specified. Besides you can show modified in the templates,
feed entries in feed readers will be updated automatically when you set
modified to the current date after you modified your article.

authors is a comma-separated list of article authors. If there's only one
author you can use author field.

If you do not explicitly specify summary metadata for a given post, the
SUMMARY_MAX_LENGTH setting can be used to specify how many words from the
beginning of an article are used as the summary. You can also use an article's
first N paragraphs as its summary using the SUMMARY_MAX_PARAGRAPHS setting.
If both settings are in use, the specified number of paragraphs will
be used but may be truncated to respect the specified maximum length.

You can also extract any metadata from the filename through a regular
expression to be set in the FILENAME_METADATA setting. All named groups
that are matched will be set in the metadata object. The default value for the
FILENAME_METADATA setting will only extract the date from the filename. For
example, if you would like to extract both the date and the slug, you could set
something like: '(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'

Please note that the metadata available inside your files takes precedence over
the metadata extracted from the filename.

Pages

If you create a folder named pages inside the content folder, all the
files in it will be used to generate static pages, such as About or
Contact pages. (See example filesystem layout below.)

You can use the DISPLAY_PAGES_ON_MENU setting to control whether all those
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,
then add a status: hidden attribute to its metadata. This is useful for
things like making error pages that fit the generated theme of your site.

Static content

Static files are files other than articles and pages that are copied to the
output folder as-is, without processing. You can control which static files
are copied over with the STATIC_PATHS setting of the project's
pelicanconf.py file. Pelican's default configuration includes the
images directory for this, but others must be added manually. In addition,
static files that are explicitly linked to are included (see below).

.. note::

In the default configuration, all files with a valid content file suffix
(.html, .rst, .md, ...) get processed by the article and page
generators before the static generator. This is avoided by altering the
*_EXCLUDE settings appropriately.

Mixed content in the same directory

Starting with Pelican 3.5, static files can safely share a source directory
with page source files, without exposing the page sources in the generated
site. Any such directory must be added to both STATIC_PATHS and
PAGE_PATHS (or STATIC_PATHS and ARTICLE_PATHS). Pelican will
identify and process the page source files normally, and copy the remaining
files as if they lived in a separate directory reserved for static files.

Note: Placing static and content source files together in the same source
directory does not guarantee that they will end up in the same place in the
generated site. The easiest way to do this is by using the {attach} link
syntax (described below). Alternatively, the STATIC_SAVE_AS,
PAGE_SAVE_AS, and ARTICLE_SAVE_AS settings (and the corresponding
*_URL settings) can be configured to place files of different types
together, just as they could in earlier versions of Pelican.

.. _ref-linking-to-internal-content:

Linking to internal content

From Pelican 3.1 onwards, it is now possible to specify intra-site links to
files in the source content hierarchy instead of files in the generated
hierarchy. This makes it easier to link from the current post to other content
that may be sitting alongside that post (instead of having to determine where
the other content will be placed after site generation).

To link to internal content (files in the content directory), use the
following syntax for the link target: {filename}path/to/file.
Note: forward slashes, /,
are the required path separator in the {filename} directive
on all operating systems, including Windows.

For example, a Pelican project might be structured like this::

text
website/
├── content
│   ├── category/
│   │   └── article1.rst
│   ├── article2.md
│   └── pages
│       └── about.md
└── pelican.conf.py

In this example, article1.rst could look like this::

text
The first article
#################

:date: 2012-12-01 10:02

See below intra-site link examples in reStructuredText format.

`a link relative to the current file <{filename}../article2.md>`_
`a link relative to the content root <{filename}/article2.md>`_

and article2.md::

text
Title: The second article
Date: 2012-12-01 10:02

See below intra-site link examples in Markdown format.

[a link relative to the current file]({filename}category/article1.rst)
[a link relative to the content root]({filename}/category/article1.rst)

Linking to static files

You can link to static content using {static}path/to/file. Files linked to
with this syntax will automatically be copied to the output directory, even if
the source directories containing them are not included in the STATIC_PATHS
setting of the project's pelicanconf.py file.

For example, a project's content directory might be structured like this::

text
content
├── images
│   └── han.jpg
├── pdfs
│   └── menu.pdf
└── pages
    └── test.md

test.md would include::

text
[Our Menu]({static}/pdfs/menu.pdf)

Site generation would then copy han.jpg to output/images/han.jpg,
menu.pdf to output/pdfs/menu.pdf, and write the appropriate links
in test.md.

If you use {static} to link to an article or a page, this will be turned
into a link to its source code.

Attaching static files

Starting with Pelican 3.5, static files can be "attached" to a page or article
using this syntax for the link target: {attach}path/to/file. This works
like the {static} syntax, but also relocates the static file into the
linking document's output directory. If the static file originates from a
subdirectory beneath the linking document's source, that relationship will be
preserved on output. Otherwise, it will become a sibling of the linking
document.

This only works for linking to static files.

For example, a project's content directory might be structured like this::

text
content
├── blog
│   ├── icons
│   │   └── icon.png
│   ├── photo.jpg
│   └── testpost.md
└── downloads
    └── archive.zip

pelicanconf.py would include::

text
PATH = 'content'
ARTICLE_PATHS = ['blog']
ARTICLE_SAVE_AS = '{date:%Y}/{slug}.html'
ARTICLE_URL = '{date:%Y}/{slug}.html'

testpost.md would include::

text
Title: Test Post
Category: test
Date: 2014-10-31



[Downloadable File]({attach}/downloads/archive.zip)

Site generation would then produce an output directory structured like this::

text
output
└── 2014
    ├── archive.zip
    ├── icons
    │   └── icon.png
    ├── photo.jpg
    └── test-post.html

Notice that all the files linked using {attach} ended up in or beneath
the article's output directory.

If a static file is linked multiple times, the relocating feature of
{attach} will only work in the first of those links to be processed.
After the first link, Pelican will treat {attach} like {static}.
This avoids breaking the already-processed links.

Be careful when linking to a file from multiple documents:
Since the first link to a file finalizes its location and Pelican does
not define the order in which documents are processed, using {attach} on a
file linked by multiple documents can cause its location to change from one
site build to the next. (Whether this happens in practice will depend on the
operating system, file system, version of Pelican, and documents being added,
modified, or removed from the project.) Any external sites linking to the
file's old location might then find their links broken. It is therefore
advisable to use {attach} only if you use it in all links to a file, and only
if the linking documents share a single directory. Under these conditions,
the file's output location will not change in future builds. In cases where
these precautions are not possible, consider using {static} links instead
of {attach}, and letting the file's location be determined by the project's
STATIC_SAVE_AS and STATIC_URL settings. (Per-file save_as and
url overrides can still be set in EXTRA_PATH_METADATA.)

.. note::
When using {attach}, any parent directory in *_URL / *_SAVE_AS
settings should match each other. See also: :ref:url-settings

Linking to authors, categories, index and tags

You can link to authors, categories, index and tags using the {author}name,
{category}foobar, {index} and {tag}tagname syntax.

To remain compatible with earlier versions, Pelican still supports vertical
bars (||) in addition to curly braces ({}) for internal links. For
example: |filename|an_article.rst, |tag|tagname, |category|foobar.
The syntax was changed from || to {} to avoid collision with Markdown
extensions or reST directives. Similarly, Pelican also still supports linking
to static content with {filename}. The syntax was changed to {static}
to allow linking to both generated articles and pages and their static sources.

Support for the old syntax may eventually be removed.

Including other files

Both Markdown and reStructuredText syntaxes provide mechanisms for this.

Following below are some examples for reStructuredText using the include directive_:

text
.. code-block:: rst

    .. include:: file.rst

Include a fragment of a file delimited by two identifiers, highlighted as C++ (slicing based on line numbers is also possible):

text
.. code-block:: rst

    .. include:: main.cpp
        :code: c++
        :start-after: // begin
        :end-before: // end

Include a raw HTML file (or an inline SVG) and put it directly into the output without any processing:

text
.. code-block:: rst

    .. raw:: html
        :file: table.html

For Markdown, one must rely on an extension. For example, using the mdx_include plugin_:

text
.. code-block:: none

    ```html
    {! template.html !}
    ```

Importing an existing site

It is possible to import your site from several other blogging sites
(like WordPress, Tumblr, ..) using a simple script. See :ref:import.

Translations

It is possible to translate articles. To do so, you need to add a lang meta
attribute to your articles/pages and set a DEFAULT_LANG setting (which is
English [en] by default). With those settings in place, only articles with the
default language will be listed, and each article will be accompanied by a list
of available translations for that article.

.. note::

This core Pelican functionality does not create sub-sites
(e.g. example.com/de) with translated templates for each
language. For such advanced functionality the i18n_subsites plugin_ can be used.

By default, Pelican uses the article's URL "slug" to determine if two or more
articles are translations of one another. (This can be changed with the
ARTICLE_TRANSLATION_ID setting.) The slug can be set manually in the file's
metadata; if not set explicitly, Pelican will auto-generate the slug from the
title of the article.

Here is an example of two articles, one in English and the other in French.

The English article::

text
Foobar is not dead
##################

:slug: foobar-is-not-dead
:lang: en

That's true, foobar is still alive!

And the French version::

text
Foobar n'est pas mort !
#######################

:slug: foobar-is-not-dead
:lang: fr

Oui oui, foobar est toujours vivant !

Post content quality notwithstanding, you can see that only item in common
between the two articles is the slug, which is functioning here as an
identifier. If you'd rather not explicitly define the slug this way, you must
then instead ensure that the translated article titles are identical, since the
slug will be auto-generated from the article title.

If you do not want the original version of one specific article to be detected
by the DEFAULT_LANG setting, use the translation metadata to specify
which posts are translations::

text
Foobar is not dead
##################

:slug: foobar-is-not-dead
:lang: en
:translation: true

That's true, foobar is still alive!

.. _internal_pygments_options:

Syntax highlighting

Pelican can provide colorized syntax highlighting for your code blocks.
To do so, you must use the following conventions inside your content files.

For reStructuredText, use the code-block directive to specify the type
of code to be highlighted (in these examples, we'll use python)::

text
.. code-block:: python

   print("Pelican is a static site generator.")

For Markdown, which utilizes the CodeHilite extension_ to provide syntax
highlighting, include the language identifier just above the code block,
indenting both the identifier and the code::

text
There are two ways to specify the identifier:

    :::python
    print("The triple-colon syntax will *not* show line numbers.")

To display line numbers, use a path-less shebang instead of colons:

    #!python
    print("The path-less shebang syntax *will* show line numbers.")

The specified identifier (e.g. python, ruby) should be one that
appears on the list of available lexers <https://pygments.org/docs/lexers/>_.

When using reStructuredText the following options are available in the
code-block directive:

============= ============ =========================================
Option Valid values Description
============= ============ =========================================
anchorlinenos N/A If present, wrap line numbers in <a> tags.
classprefix string String to prepend to token class names
hl_lines numbers List of lines to be highlighted, where
line numbers to highlight are separated
by a space. This is similar to
emphasize-lines in Sphinx, but it
does not support a range of line numbers
separated by a hyphen, or comma-separated
line numbers.
lineanchors string Wrap each line in an anchor using this
string and -linenumber.
linenos string If present or set to "table", output line
numbers in a table; if set to
"inline", output them inline. "none" means
do not output the line numbers for this
table.
linenospecial number If set, every nth line will be given the
'special' CSS class.
linenostart number Line number for the first line.
linenostep number Print every nth line number.
lineseparator string String to print between lines of code,
'\n' by default.
linespans string Wrap each line in a span using this and
-linenumber.
nobackground N/A If set, do not output background color for
the wrapping element
nowrap N/A If set, do not wrap the tokens at all.
tagsfile string ctags file to use for name definitions.
tagurlformat string format for the ctag links.
============= ============ =========================================

Note that, depending on the version, your Pygments module might not have
all of these options available. Refer to the HtmlFormatter section of the
Pygments documentation <https://pygments.org/docs/formatters/>_ for more
details on each of the options.

For example, the following code block enables line numbers, starting at 153,
and prefixes the Pygments CSS classes with pgcss to make the names
more unique and avoid possible CSS conflicts::

text
.. code-block:: identifier
    :classprefix: pgcss
    :linenos: table
    :linenostart: 153

It is also possible to specify the PYGMENTS_RST_OPTIONS variable in your
Pelican settings file to include options that will be automatically applied to
every code block.

For example, if you want to have line numbers displayed for every code block
and a CSS prefix, you would set this variable to::

text
PYGMENTS_RST_OPTIONS = {'classprefix': 'pgcss', 'linenos': 'table'}

If specified, settings for individual code blocks will override the defaults in
your settings file.

Publishing drafts

If you want to publish an article or a page as a draft (for friends to review
before publishing, for example), you can add a Status: draft attribute to
its metadata. That article will then be output to the drafts folder and not
listed on the index page nor on any category or tag page.

If your articles should be automatically published as a draft (to not
accidentally publish an article before it is finished), include the status in
the DEFAULT_METADATA::

text
DEFAULT_METADATA = {
    'status': 'draft',
}

To publish a post when the default status is draft, update the post's
metadata to include Status: published.

Hidden Posts

Like pages, posts can also be marked as hidden with the Status: hidden
attribute. Hidden posts will be output to ARTICLE_SAVE_AS as expected, but
are not included by default in tag, category, and author indexes, nor in the
main article feed. This has the effect of creating an "unlisted" post.

Skip Posts

Posts marked with skip status are ignored entirely. They are not processed
nor output to the ARTICLE_SAVE_AS path. Such posts will similarly not be
included in indexes or feeds.

.. _W3C ISO 8601: https://www.w3.org/TR/NOTE-datetime
.. _AsciiDoc: https://asciidoc.org
.. _Pelican Plugins: https://github.com/pelican-plugins
.. _pelican-plugins: https://github.com/getpelican/pelican-plugins
.. _Python-Markdown: https://github.com/Python-Markdown/markdown
.. _Markdown Extensions: https://python-markdown.github.io/extensions/
.. _CodeHilite extension: https://python-markdown.github.io/extensions/code_hilite/#syntax
.. _i18n_subsites plugin: https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites
.. _the include directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html#include
.. _mdx_include plugin: https://github.com/neurobin/mdx_include

File: docs/contribute.rst

Contributing and feedback guidelines
####################################

There are many ways to contribute to Pelican. You can improve the
documentation, add missing features, and fix bugs (or just report them). You
can also help out by reviewing and commenting on
existing issues <https://github.com/getpelican/pelican/issues>_.

Don't hesitate to fork Pelican and submit an issue or pull request on GitHub.
When doing so, please consider the following guidelines.

.. include:: ../CONTRIBUTING.rst

Setting up the development environment

While there are many ways to set up one's development environment, the following
instructions will utilize Pip_ and PDM_. These tools facilitate managing
virtual environments for separate Python projects that are isolated from one
another, so you can use different packages (and package versions) for each.

Please note that Python |min_python| is required for Pelican development.

(Optional) If you prefer to install PDM <https://pdm.fming.dev/latest/#installation>_ once for use with multiple projects,
you can install it via::

text
curl -sSL https://pdm.fming.dev/install-pdm.py | python3 -

Point your web browser to the Pelican repository_ and tap the Fork button
at top-right. Then clone the source for your fork and add the upstream project
as a Git remote::

text
mkdir ~/projects
git clone https://github.com/YOUR_USERNAME/pelican.git ~/projects/pelican
cd ~/projects/pelican
git remote add upstream https://github.com/getpelican/pelican.git

While PDM can dynamically create and manage virtual environments, we're going
to manually create and activate a virtual environment::

text
mkdir ~/virtualenvs && cd ~/virtualenvs
python3 -m venv pelican
source ~/virtualenvs/pelican/*/activate

Install the needed dependencies and set up the project::

text
python -m pip install invoke
invoke setup

Your local environment should now be ready to go!

.. _Pip: https://pip.pypa.io/
.. _PDM: https://pdm.fming.dev/latest/
.. _Pelican repository: https://github.com/getpelican/pelican

Development

Once Pelican has been set up for local development, create a topic branch for
your bug fix or feature::

text
git checkout -b name-of-your-bugfix-or-feature

Now you can make changes to Pelican, its documentation, and/or other aspects of
the project.

Setting up ``git blame`` (optional)

git blame annotates lines in a file with information about the pull request
that last modified it. Sweeping shallow changes (like formatting) can make that
information less useful, so we keep a list of such changes to be ignored. Run the
following command to set this up in your repository, adding --global if you
want this setting to apply to all repositories::

text
git config blame.ignoreRevsFile .git-blame-ignore-revs

As noted in a useful article_ about git blame, there are other related
settings you may find to be beneficial::

text
# Add `?` to any lines that have had a commit skipped using --ignore-rev
git config --global blame.markIgnoredLines true
# Add `*` to any lines that were added in a skipped commit and can not be attributed
git config --global blame.markUnblamableLines true

.. _useful article: https://www.michaelheap.com/git-ignore-rev/

Running the test suite

Each time you make changes to Pelican, there are two things to do regarding
tests: check that the existing tests pass, and add tests for any new features
or bug fixes. The tests are located in pelican/tests, and you can run them
via::

text
invoke tests

(For more on Invoke, see invoke -l to list tasks, or
https://pyinvoke.org for documentation.)

In addition to running the test suite, it is important to also ensure that any
lines you changed conform to code style guidelines. You can check that via::

text
invoke lint

If style violations are found, many of them can be addressed automatically via::

text
invoke lint --fix
invoke format

If code style violations are found in lines you changed, correct those lines
and re-run the invoke lint command until they have all been fixed. You do
not need to address style violations, if any, for code lines you did not touch.

After making your changes and running the tests, you may see a test failure
mentioning that "some generated files differ from the expected functional tests
output." If you have made changes that affect the HTML output generated by
Pelican, and the changes to that output are expected and deemed correct given
the nature of your changes, then you should update the output used by the
functional tests. To do so, make sure you have both en_EN.utf8 and
fr_FR.utf8 locales installed, and then run the following command::

text
invoke update-functional-tests

You may also find that some tests are skipped because some dependency (e.g.,
Pandoc) is not installed. This does not automatically mean that these tests
have passed; you should at least verify that any skipped tests are not affected
by your changes.

You should run the test suite under each of the supported versions of Python.
This is best done by creating a separate Python environment for each version.
Tox_ is a useful tool to automate running tests inside virtualenv
environments.

.. _Tox: https://tox.readthedocs.io/en/latest/

Running a code coverage report

Code is more likely to stay robust if it is tested. Coverage_ is a library that
measures how much of the code is tested. To run it::

text
invoke coverage

This will show overall coverage, coverage per file, and even line-by-line coverage.
There is also an HTML report available::

text
open htmlcov/index.html

.. _Coverage: https://github.com/nedbat/coveragepy

Building the docs

If you make changes to the documentation, you should build and inspect your
changes before committing them::

text
invoke docserve

Open http://localhost:8000 in your browser to review the documentation. While
the above task is running, any changes you make and save to the documentation
should automatically appear in the browser, as it live-reloads when it detects
changes to the documentation source files.

Plugin development

To create a new Pelican plugin, please refer to the plugin template_
repository for detailed instructions.

If you want to contribute to an existing Pelican plugin, follow the steps
above to set up Pelican for local development, and then create a directory to
store cloned plugin repositories::

mkdir -p ~/projects/pelican-plugins

Assuming you wanted to contribute to the Simple Footnotes plugin, you would
first browse to the Simple Footnotes_ repository on GitHub and tap the Fork
button at top-right. Then clone the source for your fork and add the upstream
project as a Git remote::

text
git clone https://github.com/YOUR_USERNAME/simple-footnotes.git ~/projects/pelican-plugins/simple-footnotes
cd ~/projects/pelican-plugins/simple-footnotes
git remote add upstream https://github.com/pelican-plugins/simple-footnotes.git

Install the needed dependencies and set up the project::

text
invoke setup

Create a topic branch for your plugin bug fix or feature::

text
git checkout -b name-of-your-bugfix-or-feature

After writing new tests for your plugin changes, run the plugin test suite and
check for code style compliance via::

text
invoke tests
invoke lint

If style violations are found, many of them can be addressed automatically via::

text
invoke lint --fix
invoke format

If style violations are found even after running the above auto-formatters,
you will need to make additional manual changes until invoke lint no longer
reports any code style violations.

.. _plugin template: https://github.com/getpelican/cookiecutter-pelican-plugin
.. _Simple Footnotes: https://github.com/pelican-plugins/simple-footnotes

Submitting your changes

Assuming linting validation and tests pass, add a RELEASE.md file in the root
of the project that contains the release type (major, minor, patch) and a
summary of the changes that will be used as the release changelog entry.
For example::

text
Release type: patch

Fix browser reloading upon changes to content, settings, or theme

Commit your changes and push your topic branch::

text
git add .
git commit -m "Your detailed description of your changes"
git push origin name-of-your-bugfix-or-feature

Finally, browse to your repository fork on GitHub and submit a pull request.

Logging tips

Try to use logging with appropriate levels.

For logging messages that are not repeated, use the usual Python way::

text
# at top of file
import logging
logger = logging.getLogger(__name__)

# when needed
logger.warning("A warning with %s formatting", arg_to_be_formatted)

Do not format log messages yourself. Use %s formatting in messages and pass
arguments to logger. This is important, because the Pelican logger will
preprocess some arguments, such as exceptions.

Limiting extraneous log messages

If the log message can occur several times, you may want to limit the log to
prevent flooding. In order to do that, use the extra keyword argument for
the logging message in the following format::

text
logger.warning("A warning with %s formatting", arg_to_be_formatted,
    extra={'limit_msg': 'A generic message for too many warnings'})

Optionally, you can also set 'limit_args' as a tuple of arguments in
extra dict if your generic message needs formatting.

Limit is set to 5, i.e, first four logs with the same 'limit_msg' are
outputted normally but the fifth one will be logged using 'limit_msg' (and
'limit_args' if present). After the fifth, corresponding log messages will
be ignored.

For example, if you want to log missing resources, use the following code::

text
for resource in resources:
    if resource.is_missing:
        logger.warning(
            'The resource %s is missing', resource.name,
            extra={'limit_msg': 'Other resources were missing'})

The log messages will be displayed as follows::

text
WARNING: The resource prettiest_cat.jpg is missing
WARNING: The resource best_cat_ever.jpg is missing
WARNING: The resource cutest_cat.jpg is missing
WARNING: The resource lolcat.jpg is missing
WARNING: Other resources were missing

Outputting traceback in the logs

If you're logging inside an except block, you may want to provide the
traceback information as well. You can do that by setting exc_info keyword
argument to True during logging. However, doing so by default can be
undesired because tracebacks are long and can be confusing to regular users.
Try to limit them to --debug mode like the following::

text
try:
    some_action()
except Exception as e:
    logger.error('Exception occurred: %s', e,
        exc_info=settings.get('DEBUG', False))

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#pelican Browse pelican catalog → #python Browse python catalog → #static-site-generator Browse static-site-generator catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →