Static site generator that supports reStructuredText and Markdown content. Written in Python.
Project description
Pelican
Pelican is a static site generator, written in Python.
Write your weblog entries directly with your editor of choice (vim!) in reStructuredText or Markdown
Includes a simple CLI tool to (re)generate the weblog
Easy to interface with DVCSes and web hooks
Completely static output is easy to host anywhere
Features
Pelican currently supports:
Blog articles and pages
Comments, via an external service (Disqus). (Please note that while useful, Disqus is an external service, and thus the comment data will be somewhat outside of your control and potentially subject to data loss.)
Theming support (themes are created using Jinja2 templates)
PDF generation of the articles/pages (optional)
Publication of articles in multiple languages
Atom/RSS feeds
Code syntax highlighting
Import from WordPress, Dotclear, or RSS feeds
Integration with external tools: Twitter, Google Analytics, etc. (optional)
Fast rebuild times thanks to content caching and selective output writing.
Have a look at the Pelican documentation for more information.
Why the name “Pelican”?
“Pelican” is an anagram for calepin, which means “notebook” in French. ;)
Source code
You can access the source code at: https://github.com/getpelican/pelican
If you feel hackish, have a look at the explanation of Pelican’s internals.
How to get help, contribute, or provide feedback
See our contribution submission and feedback guidelines.
Release history
3.5.0 (2014-11-04)
Introduce ARTICLE_ORDER_BY and PAGE_ORDER_BY settings to control the order of articles and pages.
Include time zone information in dates rendered in templates.
Expose the reader name in the metadata for articles and pages.
Add the ability to store static files along with content in the same directory as articles and pages using {attach} in the path.
Prevent Pelican from raising an exception when there are duplicate pieces of metadata in a Markdown file.
Introduce the TYPOGRIFY_IGNORE_TAGS setting to add HTML tags to be ignored by Typogrify.
Add the ability to use - in date formats to strip leading zeros. For example, %-d/%-m/%y will now result in the date 9/8/12.
Ensure feed generation is correctly disabled during quickstart configuration.
Fix PAGE_EXCLUDES and ARTICLE_EXCLUDES from incorrectly matching sub-directories.
Introduce STATIC_EXCLUDE setting to add static file excludes.
Fix an issue when using PAGINATION_PATTERNS while RELATIVE_URLS is enabled.
Fix feed generation causing links to use the wrong language for month names when using other locales.
Fix an issue where the authors list in the simple template wasn’t correctly formatted.
Fix an issue when parsing non-string URLs from settings.
Improve consistency of debug and warning messages.
3.4.0 (2014-07-01)
Speed up content generation via new caching mechanism
Add selective post generation (instead of always building entire site)
Many documentation improvements, including switching to prettier RtD theme
Add support for multiple content and plugin paths
Add :modified: metadata field to complement :date:. Used to specify the last date and time an article was updated independently from the date and time it was published.
Add support for multiple authors via new :authors: metadata field
Watch for changes in static directories when in auto-regeneration mode
Add filters to limit log output when desired
Add language support to drafts
Add SLUGIFY_SOURCE setting to control how post slugs are generated
Fix many issues relating to locale and encoding
Apply Typogrify filter to post summary
Preserve file metadata (e.g. time stamps) when copying static files to output
Move AsciiDoc support from Pelican core into separate plugin
Produce inline links instead of reference-style links when importing content
Improve handling of IGNORE_FILES setting behavior
Properly escape symbol characters in tag names (e.g., C++)
Minor tweaks for Python 3.4 compatibility
Add several new signals
3.3.0 (2013-09-24)
Drop Python 3.2 support in favor of Python 3.3
Add Fabfile so Fabric can be used for workflow automation instead of Make
OUTPUT_RETENTION setting can be used to preserve metadata (e.g., VCS data such as .hg and .git) from being removed from output directory
Tumblr import
Improve logic and consistency when cleaning output folder
Improve documentation versioning and release automation
Improve pagination flexibility
Rename signals for better consistency (some plugins may need to be updated)
Move metadata extraction from generators to readers; metadata extraction no longer article-specific
Deprecate FILES_TO_COPY in favor of STATIC_PATHS and EXTRA_PATH_METADATA
Summaries in Markdown posts no longer include footnotes
Remove unnecessary whitespace in output via lstrip_blocks Jinja parameter
Move PDF generation from core to plugin
Replace MARKUP setting with READERS
Add warning if img tag is missing alt attribute
Add support for {} in relative links syntax, besides ||
Add support for {tag} and {category} relative links
Add a content_written signal
3.2.1 and 3.2.2
Facilitate inclusion in FreeBSD Ports Collection
3.2 (2013-04-24)
Support for Python 3!
Override page save-to location from meta-data (enables using a static page as the site’s home page, for example)
Time period archives (per-year, per-month, and per-day archives of posts)
Posterous blog import
Improve WordPress blog import
Migrate plugins to separate repository
Improve HTML parser
Provide ability to show or hide categories from menu using DISPLAY_CATEGORIES_ON_MENU option
Auto-regeneration can be told to ignore files via IGNORE_FILES setting
Improve post-generation feedback to user
For multilingual posts, use meta-data to designate which is the original and which is the translation
Add .mdown to list of supported Markdown file extensions
Document-relative URL generation (RELATIVE_URLS) is now off by default
3.1 (2012-12-04)
Importer now stores slugs within files by default. This can be disabled with the --disable-slugs option.
Improve handling of links to intra-site resources
Ensure WordPress import adds paragraphs for all types of line endings in post content
Decode HTML entities within WordPress post titles on import
Improve appearance of LinkedIn icon in default theme
Add GitHub and Google+ social icons support in default theme
Optimize social icons
Add FEED_ALL_ATOM and FEED_ALL_RSS to generate feeds containing all posts regardless of their language
Split TRANSLATION_FEED into TRANSLATION_FEED_ATOM and TRANSLATION_FEED_RSS
Different feeds can now be enabled/disabled individually
Allow for blank author: if AUTHOR setting is not set, author won’t default to ${USER} anymore, and a post won’t contain any author information if the post author is empty
Move LESS and Webassets support from Pelican core to plugin
The DEFAULT_DATE setting now defaults to None, which means that articles won’t be generated unless date metadata is specified
Add FILENAME_METADATA setting to support metadata extraction from filename
Add gzip_cache plugin to compress common text files into a .gz file within the same directory as the original file, preventing the server (e.g. Nginx) from having to compress files during an HTTP call
Add support for AsciiDoc-formatted content
Add USE_FOLDER_AS_CATEGORY setting so that feature can be toggled on/off
Support arbitrary Jinja template files
Restore basic functional tests
New signals: generator_init, get_generators, and article_generate_preread
3.0 (2012-08-08)
Refactored the way URLs are handled
Improved the English documentation
Fixed packaging using setuptools entrypoints
Added typogrify support
Added a way to disable feed generation
Added support for DIRECT_TEMPLATES
Allow multiple extensions for content files
Added LESS support
Improved the import script
Added functional tests
Rsync support in the generated Makefile
Improved feed support (easily pluggable with Feedburner for instance)
Added support for abbr in reST
Fixed a bunch of bugs :-)
2.8 (2012-02-28)
Dotclear importer
Allow the usage of Markdown extensions
Themes are now easily extensible
Don’t output pagination information if there is only one page
Add a page per author, with all their articles
Improved the test suite
Made the themes easier to extend
Removed Skribit support
Added a pelican-quickstart script
Fixed timezone-related issues
Added some scripts for Windows support
Date can be specified in seconds
Never fail when generating posts (skip and continue)
Allow the use of future dates
Support having different timezones per language
Enhanced the documentation
2.7 (2011-06-11)
Use logging rather than echoing to stdout
Support custom Jinja filters
Compatibility with Python 2.5
Added a theme manager
Packaged for Debian
Added draft support
2.6 (2011-03-08)
Changes in the output directory structure
Makes templates easier to work with / create
Added RSS support (was Atom-only)
Added tag support for the feeds
Enhance the documentation
Added another theme (brownstone)
Added translations
Added a way to use cleaner URLs with a rewrite url module (or equivalent)
Added a tag cloud
Added an autoreloading feature: the blog is automatically regenerated each time a modification is detected
Translate the documentation into French
Import a blog from an RSS feed
Pagination support
Added Skribit support
2.5 (2010-11-20)
Import from Wordpress
Added some new themes (martyalchin / wide-notmyidea)
First bug report!
Linkedin support
Added a FAQ
Google Analytics support
Twitter support
Use relative URLs, not static ones
2.4 (2010-11-06)
Minor themes changes
Add Disqus support (so we have comments)
Another code refactoring
Added config settings about pages
Blog entries can also be generated in PDF
2.3 (2010-10-31)
Markdown support
2.2 (2010-10-30)
Prettify output
Manages static pages as well
2.1 (2010-10-30)
Make notmyidea the default theme
2.0 (2010-10-30)
Refactoring to be more extensible
Change into the setting variables
1.2 (2010-09-28)
Added a debug option
Added per-category feeds
Use filesystem to get dates if no metadata is provided
Add Pygments support
1.1 (2010-08-19)
First working version
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pelican-3.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56a65add1aa043141e3476b954dc5120e3cc25a98e2039ddc858e037b7045071 |
|
MD5 | e128cc770ed4ce07afe0f17a80b977ae |
|
BLAKE2b-256 | f762587f6ecf05b730006449d2833f8c0118b36d0aaf13e30cd2739ddc16fd8d |