1
0
Fork 0
forked from github/pelican
Custom Pelican theme, colorway heavily inspired by rosepinetheme.com https://lugh.ch
  • CSS 68.5%
  • HTML 26.5%
  • JavaScript 5%
Find a file
Justin Mayer 838478d65d Merge pull request #1629 from avaris/fix_windows_tests
Fix tests that were skipped in #1581
2015-02-17 18:03:57 -08:00
docs Merge pull request #1581 from georgevreilly/win-fixes 2015-02-17 17:06:19 -08:00
pelican Fix tests that were skipped in #1581 2015-02-17 20:50:27 -05:00
samples Change documented type of various settings 2015-01-17 18:15:24 -08:00
.coveragerc [coveralls] Exclude tests from coverage 2014-06-24 22:29:36 +01:00
.gitattributes Fixed line ending problems by adding a .gitattributes file 2012-11-29 15:00:44 +01:00
.gitignore Port pelican to python 3. 2013-01-11 03:20:09 +01:00
.mailmap .mailmap: Add mappings to consolidate author names and emails 2013-04-12 10:51:48 -04:00
.travis.yml Add pandoc package to Travis CI configuration 2015-02-09 08:22:30 -08:00
bumpr.rc Build binary wheels when publishing to PyPI 2014-07-01 12:16:45 -07:00
CONTRIBUTING.rst fix headers, this fixes issues with docs/contributing.rst throwing errors because of the different content structure 2015-01-05 12:36:35 +01:00
dev_requirements.txt Build binary wheels when publishing to PyPI 2014-07-01 12:16:45 -07:00
LICENSE Include the complete license rather than the short version. See #103 2011-04-26 13:46:02 +01:00
MANIFEST.in Don't include all the .py files in the root folder 2013-06-07 00:50:51 +02:00
README.rst Use Shields.io as source for Travis badge 2015-01-02 01:11:51 -08:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Increment version to 3.5 2014-11-04 19:43:14 -08:00
THANKS minor spelling fixes 2014-09-15 20:29:00 -04:00
tox.ini Add python 3.4 to tox config. 2014-04-17 22:57:26 +02:00

Pelican |build-status| |coverage-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)
* 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 <CONTRIBUTING.rst>`_.

.. 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/
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html

.. |build-status| image:: https://img.shields.io/travis/getpelican/pelican/master.svg
   :target: https://travis-ci.org/getpelican/pelican
   :alt: Travis CI: continuous integration status
.. |coverage-status| image:: https://img.shields.io/coveralls/getpelican/pelican.svg
   :target: https://coveralls.io/r/getpelican/pelican
   :alt: Coveralls: code coverage status