docs.getpelican.comPelican 4.2.0 — Pelican 4.2.0 documentation

-- Pelican stable Quickstart Installing Pelican Writing content Publish your site Settings Creating themes Plugins pelican-themes Importing an existing site Frequently Asked Questions (FAQ) Tips Contributing and feedback guidelines Pelican internals Some history about Pelican Release history Pelican Docs » Pelican 4.2.0 Edit on GitHub Pelican 4.2.0 ¶ Pelican is a static site generator, written in Python . Highlights include: Write your content directly with your editor of choice in reStructuredText or Markdown formats Includes a simple CLI tool to (re)generate your site Easy to interface with distributed version control systems and web hooks Completely static output is easy to host anywhere Ready to get started? Check out the Quickstart guide. Features ¶ Pelican 4 currently supports: Articles (e.g., blog posts) and pages (e.g., “About”, “Projects”, “Contact”) Comments, via an external service (Disqus). If you prefer to have more control over your comment data, self-hosted comments are another option. Check out the Pelican Plugins repository for more details. Theming support (themes are created using Jinja2 templates) 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 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 How to get help, contribute, or provide feedback ¶ See our feedback and contribution submission guidelines . Documentation ¶ Quickstart Installation Create a project Create an article Generate your site Preview your site Footnotes Installing Pelican Optional packages Dependencies Upgrading Kickstart your site Writing content Articles and pages File metadata Pages Static content Linking to internal content Importing an existing site Translations Syntax highlighting Publishing drafts Publish your site Site generation Deployment Automation Settings Basic settings URL settings Time and Date Template pages Metadata Feed settings Pagination Translations Ordering content Themes Logging Reading only modified content Writing only selected content Example settings Creating themes Structure Templates and variables Objects Feeds Inheritance Plugins How to use plugins Where to find plugins How to create plugins List of signals Recipes pelican-themes Description Examples Importing an existing site Description Dependencies Usage Examples Tests Frequently Asked Questions (FAQ) What’s the best way to communicate a problem, question, or suggestion? How can I help? Is the Pelican settings file mandatory? Changes to the settings file take no effect I’m creating my own theme. How do I use Pygments for syntax highlighting? How do I create my own theme? I want to use Markdown, but I got an error. Can I use arbitrary metadata in my templates? How do I assign custom templates on a per-page basis? How can I override the generated URL of a specific page or article? How can I use a static page as my home page? What if I want to disable feed generation? I’m getting a warning about feeds generated without SITEURL being set properly My feeds are broken since I upgraded to Pelican 3.x Is Pelican only suitable for blogs? Why does Pelican always write all HTML files even with content caching enabled? How to process only a subset of all articles? My tag-cloud is missing/broken since I upgraded Pelican Since I upgraded Pelican my pages are no longer rendered How can I stop Pelican from trying to parse my static files as content? Tips Custom 404 Pages Publishing to GitHub How to add YouTube or Vimeo Videos Develop Locally Using SSL Contributing and feedback guidelines Filing issues How to get help Contributing code Setting up the development environment Building the docs Running the test suite Python 2/3 compatibility development tips Logging tips Pelican internals Overall structure How to implement a new reader? How to implement a new generator? Some history about Pelican Use case Design process In more detail Release history 4.2.0 - 2019-10-17 4.1.3 - 2019-10-09 4.1.2 - 2019-09-23 4.1.1 - 2019-08-23 4.1.0 - 2019-07-14 4.0.1 (2018-11-30) 4.0.0 (2018-11-13) 3.7.1 (2017-01-10) 3.7.0 (2016-12-12) 3.6.3 (2015-08-14) 3.6.2 (2015-08-01) 3.6.0 (2015-06-15) 3.5.0 (2014-11-04) 3.4.0 (2014-07-01) 3.3.0 (2013-09-24) 3.2.1 and 3.2.2 3.2 (2013-04-24) 3.1 (2012-12-04) 3.0 (2012-08-08) 2.8 (2012-02-28) 2.7 (2011-06-11) 2.6 (2011-03-08) 2.5 (2010-11-20) 2.4 (2010-11-06) 2.3 (2010-10-31) 2.2 (2010-10-30) 2.1 (2010-10-30) 2.0 (2010-10-30) 1.2 (2010-09-28) 1.1 (2010-08-19) Next © Copyright 2010 – present, Alexis Metaireau and contributors Revision 01eb08c4 . Built with Sphinx using a theme provided by Read the Docs . Read the Docs v: stable Versions latest stable 4.2.0 4.1.3 4.1.2 4.1.1 4.1.0 4.0.1 4.0.0 3.7.1 3.7.0 3.6.3 3.6.2 3.6.0 3.5.0 3.4.0 3.3.0 3.2 3.1.1 3.0 2.8 Downloads pdf html epub On Read the Docs Project Home Builds Free document hosting provided by Read the Docs ....