weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Prepare for 3.0 release, make README more readable

Browse source 
Since PyPI doesn't seem to handle anything but the most basic of reST
formatting, moving the inline links to the end of the file should
improve readability when the file is viewed in its raw form. Also
updated changelog with the 3.0 release date.
This commit is contained in:
Justin Mayer 2012-08-06 07:40:10 -07:00
commit c0e3926b0d
3 changed files with 50 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.rst
View file

@ -1,12 +1,12 @@
Pelican
#######
=======
.. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master
Pelican is a static site generator, written in `Python <http://www.python.org/>`_.
Pelican is a static site generator, written in Python_.
* Write your weblog entries directly with your editor of choice (vim!)
in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ or `Markdown <http://daringfireball.net/projects/markdown/>`_
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
@ -20,20 +20,19 @@ Pelican currently supports:
* 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 <http://jinja.pocoo.org/>`_)
* 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
* Compilation of `LESS CSS <http://lesscss.org/>`_ (optional)
* Compilation of `LESS CSS`_ (optional)
* Import from WordPress, Dotclear, or RSS feeds
* Integration with external tools: Twitter, Google Analytics, etc. (optional)
Have a look at `the documentation <http://docs.getpelican.com/latest/>`_ for
more information.
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. ;)
@ -42,19 +41,28 @@ 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
<http://docs.getpelican.com/en/latest/internals.html>`_.
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
<http://docs.getpelican.com/en/latest/contribute.html>`_. That's open source, dude!
clone the repository, etc. There are many ways to contribute_. That's open
source, dude!
Send a message to "alexis at notmyidea dot org" with any requests/feedback! You
can also join the team at
`#pelican on Freenode <irc://irc.freenode.net/pelican>`_ (or if you don't have
a IRC client handy, use `the webchat
<http://webchat.freenode.net/?channels=pelican&uio=d4>`_)
for quick feedback.
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/
.. _`LESS CSS`: http://lesscss.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