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
Ondrej Grover 2e1b16826b Enhance feedback and contributing guidelines
Many folks ask for help (via IRC or filing GitHub issues) without
sufficient detail and/or without first determining if the answers to
their questions might be better sourced elsewhere. These
documentation changes encourage users to follow certain guidelines
when reaching out for help.
2014-06-30 18:34:18 -07:00
docs Enhance feedback and contributing guidelines 2014-06-30 18:34:18 -07:00
pelican Generator.get_files backwards compatibility for 1 path 2014-06-27 20:18:17 +02:00
samples Fix test errors on OSX 2014-06-26 01:01:42 -04: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 Remove AsciiDocReader from core. Fixes #1355 2014-06-14 02:17:43 -04:00
bumpr.rc Modify sed command in bumpr.rc to support BSD 2013-09-24 21:37:53 +02:00
CONTRIBUTING.rst Enhance feedback and contributing guidelines 2014-06-30 18:34:18 -07:00
dev_requirements.txt Added new sphinxtheme as requirement for docs Modified docs conf to support the theme update 2014-04-15 10:37:25 -04: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 Enhance feedback and contributing guidelines 2014-06-30 18:34:18 -07:00
setup.cfg Build Pelican wheels in universal format 2013-11-13 13:44:28 -08:00
setup.py Require six version 1.4.0 or later. 2014-06-10 08:35:33 +09:00
THANKS Document video support in Markdown and reST. 2013-10-25 10:52:13 +02:00
tox.ini Add python 3.4 to tox config. 2014-04-17 22:57:26 +02:00

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)
* 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