mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Static site generator that supports Markdown and reST syntax. Powered by Python.
- Python 85.3%
- CSS 8.7%
- Jinja 6%
6f36b0a246
If DELETE_OUTPUT_DIRECTORY is set to True, all files and directories are
deleted from the output directory. There are, however, several reasons
one might want to retain certain files/directories and avoid their
deletion from the output directory. One such use case is version control
system data: a versioned output directory can facilitate deployment via
Heroku and/or allow the user to easily revert to a prior version of the
site without having to rely on regeneration via Pelican.
This change introduces the OUTPUT_RETENTION setting, a tuple of
filenames that will be preserved when the clean_output_dir function in
pelican.utils is run. Setting OUTPUT_RETENTION = (".hg", ".git") would,
for example, prevent the relevant VCS data from being deleted when the
output directory is cleaned.
|
||
|---|---|---|
| docs | ||
| pelican | ||
| samples | ||
| .gitattributes | ||
| .gitignore | ||
| .hgignore | ||
| .hgtags | ||
| .mailmap | ||
| .travis.yml | ||
| CONTRIBUTING.rst | ||
| dev_requirements.txt | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| setup.py | ||
| THANKS | ||
| tox.ini | ||
Pelican ======= .. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master :target: http://travis-ci.org/getpelican/pelican :alt: Travis-ci: continuous integration status. 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) 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`_. Feedback / Contact us --------------------- If you want to see new features in Pelican, don't hesitate to offer suggestions, clone the repository, etc. There are many ways to contribute_. That's open source, dude! Send a message to "authors at getpelican dot com" with any requests/feedback! You can also join the team at `#pelican on Freenode`_ (or if you don't have an IRC client handy, use the webchat_ for quick feedback. .. Links .. _Python: http://www.python.org/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Markdown: http://daringfireball.net/projects/markdown/ .. _Jinja2: http://jinja.pocoo.org/ .. _`Pelican documentation`: http://docs.getpelican.com/latest/ .. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html .. _`#pelican on Freenode`: irc://irc.freenode.net/pelican .. _webchat: http://webchat.freenode.net/?channels=pelican&uio=d4 .. _contribute: http://docs.getpelican.com/en/latest/contribute.html