From 6b1434f7a7ff5d253add83246515f1451e8eca70 Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Wed, 19 Jan 2011 16:22:15 +0100 Subject: [PATCH] Add a FAQ. --- docs/faq.rst | 38 ++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/themes.rst | 1 + 3 files changed, 40 insertions(+) create mode 100644 docs/faq.rst diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..bee1dd54 --- /dev/null +++ b/docs/faq.rst @@ -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 `_ + +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 +`_. + +If you want to contribute, please have a look to `the git repository +`_, 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. diff --git a/docs/index.rst b/docs/index.rst index 5fd8f8b7..a493f57e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,3 +50,4 @@ Documentation settings themes internals + faq diff --git a/docs/themes.rst b/docs/themes.rst index 0ddd2498..2783df1e 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -1,5 +1,6 @@ How to create themes for pelican ################################ +.. _theming-pelican: Pelican uses the great `jinja2 `_ templating engine to generate it's HTML output. The jinja2 syntax is really simple. If you want to