1
0
Fork 0
forked from github/pelican

Add a FAQ.

This commit is contained in:
Alexis Metaireau 2011-01-19 16:22:15 +01:00
commit 6b1434f7a7
3 changed files with 40 additions and 0 deletions

38
docs/faq.rst Normal file
View file

@ -0,0 +1,38 @@
Frequently Asked Questions (FAQ)
################################
Here is a summary of the frequently asked questions for pelican.
Is it mandatory to have a configuration file ?
==============================================
No, it's not. Configurations files are just an easy way to configure pelican.
For the basic operations, it's possible to specify options while invoking
pelican with the command line (see `pelican --help` for more informations about
that)
I'm creating my own theme, how to use pygments ?
================================================
Pygment add some classes to the generated content, so the theming of your theme
will be done thanks to a css file. You can have a look to the one proposed by
default `on the project website <http://pygments.org/demo/15101/>`_
How do I create my own theme ?
==============================
Please refer yourself to :ref:`theming-pelican`.
How can I help ?
================
You have different options to help. First, you can use pelican, and report any
idea or problem you have on `the bugtracker
<http://github.com/ametaireau/pelican/issues>`_.
If you want to contribute, please have a look to `the git repository
<https://github.com/ametaireau/pelican/>`_, fork it, add your changes and do
a pull request, I'll review them as soon as possible.
You can also contribute by creating themes, and making the documentation
better.

View file

@ -50,3 +50,4 @@ Documentation
settings
themes
internals
faq

View file

@ -1,5 +1,6 @@
How to create themes for pelican
################################
.. _theming-pelican:
Pelican uses the great `jinja2 <http://jinjna.pocoo.org>`_ templating engine to
generate it's HTML output. The jinja2 syntax is really simple. If you want to