{"id":24225,"library":"pelican","title":"Pelican","description":"Pelican is a static site generator written in Python. It supports Markdown and reStructuredText content, offers theming via Jinja2 templates, and generates static HTML files suitable for deployment on GitHub Pages, Netlify, etc. Current version is 4.12.0, with releases roughly twice a year.","status":"active","version":"4.12.0","language":"python","source_language":"en","source_url":"https://github.com/getpelican/pelican","tags":["static-site-generator","blog","markdown","restructuredtext","jinja2","themes"],"install":[{"cmd":"pip install pelican","lang":"bash","label":"Install Pelican"},{"cmd":"pip install pelican[markdown]","lang":"bash","label":"Install Pelican with Markdown support"}],"dependencies":[{"reason":"Required to process Markdown content","package":"markdown","optional":true},{"reason":"Required to process reStructuredText content","package":"docutils","optional":true},{"reason":"Templating engine used by Pelican themes","package":"jinja2","optional":false},{"reason":"Syntax highlighting for code blocks in generated content","package":"pygments","optional":true}],"imports":[{"note":"Pelican is a class; direct import of the module doesn't give access to the main class.","wrong":"import pelican","symbol":"Pelican","correct":"from pelican import Pelican"},{"note":"","wrong":"","symbol":"read_settings","correct":"from pelican.settings import read_settings"},{"note":"","wrong":"","symbol":"Generator","correct":"from pelican.generators import Generator"}],"quickstart":{"code":"from pelican import Pelican\nfrom pelican.settings import read_settings\n\nsettings = read_settings('pelicanconf.py')\npelican = Pelican(settings)\npelican.run()\n\n# Or use the command line:\n# pelican content -s pelicanconf.py -o output","lang":"python","description":"Basic usage: read settings from a configuration file and run Pelican to generate the site."},"warnings":[{"fix":"Upgrade to Python 3.11+.","message":"Pelican dropped support for Python 3.8 in version 4.12.0. Python 3.11 or later is required.","severity":"breaking","affected_versions":">=4.12.0"},{"fix":"Replace `pelican-quickstart` with `pelican quickstart`.","message":"The `pelican-quickstart` script is deprecated and may be removed in a future release. Use `pelican quickstart` subcommand instead.","severity":"deprecated","affected_versions":">=4.10.0"},{"fix":"Check your pelicanconf.py for correct spelling of settings.","message":"Settings are case-sensitive. Common mistake: using `SITEURL` instead of `SITEURL` (correct), but many users misspell it.","severity":"gotcha","affected_versions":"all"},{"fix":"Explicitly set `SUMMARY_MAX_PARAGRAPHS` and `SUMMARY_MAX_LENGTH` in your config if you rely on them.","message":"If you upgrade from Pelican < 4.10 to >= 4.10, the default summary generation changed: `SUMMARY_MAX_PARAGRAPHS` now defaults to None (full content), and `SUMMARY_MAX_LENGTH` also changed. Check your summaries.","severity":"gotcha","affected_versions":">=4.10.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install pelican`.","cause":"Pelican is not installed in the current Python environment.","error":"ModuleNotFoundError: No module named 'pelican'"},{"fix":"Verify that the order key exists in all your pages/articles or set a default.","cause":"Often caused by a misconfigured `PAGE_ORDER_BY` or `ARTICLE_ORDER_BY` setting that references a nonexistent metadata field.","error":"TypeError: 'NoneType' object is not callable"},{"fix":"Use `pelican -r -l` still works, but if you see this error, update Pelican. Alternatively use `pelican --autoreload --listen`.","cause":"The `-r` (auto-reload) and `-l` (launch server) flags were merged into `--autoreload` or `-r` in Pelican 4.10+.","error":"pelican: error: unrecognized arguments: -r -l"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}