pelican-theme/docs/index.rst

Pelican
=======

Pelican is a static site generator, written in Python_.

* Write your content directly with your editor of choice (vim!)
  in reStructuredText_, Markdown_, or AsciiDoc_ 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

Features
--------

Pelican currently supports:

* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
* 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)
* Publication of articles in multiple languages
* Atom/RSS feeds
* Code syntax highlighting
* PDF generation of the articles/pages (optional)
* Import from WordPress, Dotclear, or RSS feeds
* Integration with external tools: Twitter, Google Analytics, etc. (optional)

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

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 :doc:`contribute<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.

Documentation
-------------

A French version of the documentation is available at :doc:`fr/index`.

.. toctree::
   :maxdepth: 2

   getting_started
   settings
   themes
   plugins
   internals
   pelican-themes
   importer
   faq
   tips
   contribute
   report
   changelog

.. Links

.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Markdown: http://daringfireball.net/projects/markdown/
.. _AsciiDoc: http://www.methods.co.nz/asciidoc/index.html
.. _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
Update the documentation. 2010-12-14 15:31:11 +00:00			`Pelican`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`=======`
Update the documentation. 2010-12-14 15:31:11 +00:00
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`Pelican is a static site generator, written in Python_.`
Update the documentation. 2010-12-14 15:31:11 +00:00
Minor documentation improvements 2013-04-16 10:13:47 -07:00			`* Write your content directly with your editor of choice (vim!)`
			`in reStructuredText_, Markdown_, or AsciiDoc_ formats`
			`* Includes a simple CLI tool to (re)generate your site`
			`* Easy to interface with distributed version control systems and web hooks`
Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00			`* Completely static output is easy to host anywhere`
Update the documentation. 2010-12-14 15:31:11 +00:00
			`Features`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`--------`
Update the documentation. 2010-12-14 15:31:11 +00:00
			`Pelican currently supports:`

Minor documentation improvements 2013-04-16 10:13:47 -07:00			`* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")`
Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00			`* 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.)`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`* Theming support (themes are created using Jinja2_ templates)`
Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00			`* Publication of articles in multiple languages`
			`* Atom/RSS feeds`
			`* Code syntax highlighting`
Minor documentation improvements 2013-04-16 10:13:47 -07:00			`* PDF generation of the articles/pages (optional)`
Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00			`* Import from WordPress, Dotclear, or RSS feeds`
			`* Integration with external tools: Twitter, Google Analytics, etc. (optional)`
Update the documentation. 2010-12-14 15:31:11 +00:00
Various fixes and improvements to the docs 2012-08-01 18:20:12 -07:00			`Why the name "Pelican"?`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`-----------------------`
Update the documentation. 2010-12-14 15:31:11 +00:00
Doc links changed to new domain. Other doc fixes. 2012-08-04 11:15:44 -07:00			`"Pelican" is an anagram for calepin, which means "notebook" in French. ;)`
Update the documentation. 2010-12-14 15:31:11 +00:00
			`Source code`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`-----------`
Update the documentation. 2010-12-14 15:31:11 +00:00
Doc links changed to new domain. Other doc fixes. 2012-08-04 11:15:44 -07:00			`You can access the source code at: https://github.com/getpelican/pelican`
Update the documentation. 2010-12-14 15:31:11 +00:00
remove unnecessary exclamation mark 2011-06-13 18:42:31 +02:00			`Feedback / Contact us`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`---------------------`
Update the documentation. 2010-12-14 15:31:11 +00:00
Doc links changed to new domain. Other doc fixes. 2012-08-04 11:15:44 -07:00			`If you want to see new features in Pelican, don't hesitate to offer suggestions,`
			clone the repository, etc. There are many ways to :doc:`contribute<contribute>`.
			`That's open source, dude!`
Update the documentation. 2010-12-14 15:31:11 +00:00
Change email address in docs to "authors@" alias 2012-08-21 09:04:37 -07:00			`Send a message to "authors at getpelican dot com" with any requests/feedback! You`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			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.`
Update the documentation. 2010-12-14 15:31:11 +00:00
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00			`Documentation`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`-------------`
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00
Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00			A French version of the documentation is available at :doc:`fr/index`.
Integrated the french documentation to the already existing one. 2011-01-25 16:35:59 +00:00
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00			`.. toctree::`
			`:maxdepth: 2`
importer - add documentation 2011-08-03 22:06:10 +02:00
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00			`getting_started`
			`settings`
			`themes`
Plugins doc + minor design changes. 2011-06-18 01:03:53 +02:00			`plugins`
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00			`internals`
Update the features proposed by pelican on the doc. 2011-07-22 02:12:10 +02:00			`pelican-themes`
importer - add documentation 2011-08-03 22:06:10 +02:00			`importer`
Add a FAQ. 2011-01-19 16:22:15 +01:00			`faq`
add ghp-import features to push to github pages easily 2011-08-19 23:01:01 +02:00			`tips`
Add some informations about how to contribute. This would need a more precise description and some good practices to follow. 2011-05-10 23:41:27 +01:00			`contribute`
add some docs written a long time ago 2011-11-30 21:11:50 +01:00			`report`
Move changelog into docs 2012-07-18 18:41:09 +02:00			`changelog`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00
			`.. Links`

			`.. _Python: http://www.python.org/`
			`.. _reStructuredText: http://docutils.sourceforge.net/rst.html`
			`.. _Markdown: http://daringfireball.net/projects/markdown/`
Add asciidoc reader support http://www.methods.co.nz/asciidoc/index.html Processes files ending in .asc with asciidoc. Extra arguments can be passed by using the ASCIIDOC_OPTIONS config setting 2012-10-28 07:37:53 -07:00			`.. _AsciiDoc: http://www.methods.co.nz/asciidoc/index.html`
Prepare for 3.0 release, make README more readable 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. 2012-08-06 07:40:10 -07:00			`.. _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
Eliminate extraneous whitespace 2012-09-10 20:50:45 -07:00			`.. _webchat: http://webchat.freenode.net/?channels=pelican&uio=d4`