pelican-theme/docs/index.rst

Pelican |release|
=================


.. ifconfig:: release.endswith('.dev')

    .. warning::

        This documentation is for the version of Pelican currently under development.
        Were you looking for version |last_stable| documentation?


Pelican is a static site generator, written in Python_. Highlights include:

* Write your content directly with your editor of choice
  in reStructuredText_ or Markdown_ 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

Ready to get started? Check out the :doc:`Quickstart<quickstart>` guide.

Features
--------

Pelican |version| currently supports:

* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
* Comments, via an external service (Disqus). If you prefer to have more
  control over your comment data, self-hosted comments are another option.
  Check out the `Pelican Plugins`_ repository for more details.
* Theming support (themes are created using Jinja2_ templates)
* 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

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

How to get help, contribute, or provide feedback
------------------------------------------------

See our :doc:`feedback and contribution submission guidelines <contribute>`.

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

.. toctree::
   :maxdepth: 2

   quickstart
   install
   content
   publish
   settings
   themes
   plugins
   pelican-themes
   importer
   faq
   tips
   contribute
   internals
   report
   changelog

.. 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 plugins`: https://github.com/getpelican/pelican-plugins
Include version in doc and warn if it's a dev version. 2013-03-27 09:16:19 +01:00			`Pelican \|release\|`
			`=================`


			`.. ifconfig:: release.endswith('.dev')`

			`.. warning::`

			`This documentation is for the version of Pelican currently under development.`
			`Were you looking for version \|last_stable\| documentation?`

Update the documentation. 2010-12-14 15:31:11 +00:00
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`Pelican is a static site generator, written in Python_. Highlights include:`
Update the documentation. 2010-12-14 15:31:11 +00:00
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`* Write your content directly with your editor of choice`
Remove AsciiDocReader from core. Fixes #1355 2014-06-10 18:05:29 -04:00			`in reStructuredText_ or Markdown_ formats`
Minor documentation improvements 2013-04-16 10:13:47 -07:00			`* 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
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			Ready to get started? Check out the :doc:`Quickstart<quickstart>` guide.

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
Include version in doc and warn if it's a dev version. 2013-03-27 09:16:19 +01:00			`Pelican \|version\| currently supports:`
Update the documentation. 2010-12-14 15:31:11 +00:00
Minor documentation improvements 2013-04-16 10:13:47 -07:00			`* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")`
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`* Comments, via an external service (Disqus). If you prefer to have more`
			`control over your comment data, self-hosted comments are another option.`
			Check out the `Pelican Plugins`_ repository for more details.
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`
			`* Import from WordPress, Dotclear, or RSS feeds`
			`* Integration with external tools: Twitter, Google Analytics, etc. (optional)`
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`* Fast rebuild times thanks to content caching and selective output writing`
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
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-05-26 12:32:05 +02:00			`How to get help, contribute, or provide feedback`
			`------------------------------------------------`
Update the documentation. 2010-12-14 15:31:11 +00:00
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-05-26 12:32:05 +02:00			See our :doc:`feedback and contribution submission guidelines <contribute>`.
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
			`.. toctree::`
			`:maxdepth: 2`
importer - add documentation 2011-08-03 22:06:10 +02:00
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`quickstart`
			`install`
			`content`
			`publish`
Switch back the theme. Order the settings. 2010-12-15 18:01:29 +00:00			`settings`
			`themes`
Plugins doc + minor design changes. 2011-06-18 01:03:53 +02:00			`plugins`
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`
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			`internals`
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/`
			`.. _Jinja2: http://jinja.pocoo.org/`
			.. _`Pelican documentation`: http://docs.getpelican.com/latest/
			.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
Split Getting Started docs into separate sections The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site 2014-05-12 07:48:37 -07:00			.. _`Pelican plugins`: https://github.com/getpelican/pelican-plugins