forked from github/pelican
83 lines
2.2 KiB
ReStructuredText
83 lines
2.2 KiB
ReStructuredText
Pelican |release|
|
||
=================
|
||
|
||
|
||
.. ifconfig:: release.endswith('.dev')
|
||
|
||
.. warning::
|
||
|
||
This documentation is for the version of Pelican currently under
|
||
development. Were you looking for version |last_stable| documentation?
|
||
|
||
|
||
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 :doc:`Quickstart<quickstart>` guide.
|
||
|
||
Features
|
||
--------
|
||
|
||
Pelican’s feature highlights include:
|
||
|
||
* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
|
||
* Integration with external services
|
||
* Site themes (created using Jinja2_ templates)
|
||
* Publication of articles in multiple languages
|
||
* Generation of Atom and RSS feeds
|
||
* Code syntax highlighting
|
||
* Import existing content from WordPress, Dotclear, or RSS feeds
|
||
* Fast rebuild times thanks to content caching and selective output writing
|
||
* Extensible via a rich plugin ecosystem: `Pelican Plugins`_
|
||
|
||
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 :doc:`feedback and contribution submission guidelines <contribute>`.
|
||
|
||
Documentation
|
||
-------------
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
quickstart
|
||
install
|
||
content
|
||
publish
|
||
settings
|
||
plugins
|
||
themes
|
||
pelican-themes
|
||
importer
|
||
faq
|
||
tips
|
||
contribute
|
||
internals
|
||
report
|
||
changelog
|
||
|
||
.. Links
|
||
|
||
.. _Python: https://www.python.org/
|
||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||
.. _Markdown: https://daringfireball.net/projects/markdown/
|
||
.. _Jinja2: https://palletsprojects.com/p/jinja/
|
||
.. _`Pelican documentation`: https://docs.getpelican.com/latest/
|
||
.. _`Pelican's internals`: https://docs.getpelican.com/en/latest/internals.html
|
||
.. _`Pelican Plugins`: https://github.com/pelican-plugins
|