github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update the README with accurate informations.

Browse source
This commit is contained in:
Alexis Metaireau 2010-11-20 19:37:27 +00:00
commit 8fb52e1c63
1 changed files with 63 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

110
README.rst
View file

@ -35,9 +35,10 @@ You can also use a mardown syntax (with a file ending in `.md`)::
Put you content here. Put you content here.
Note that only the `date` metadata is mandatory, so you just have to add that in i Note that none of those are mendatory: if the date is not specified, pelican will
your files. The category can also be determined by the directory where the rst file rely on the mtime of your file, and the category can also be determined by the
is. For instance, the category of `python/foobar/myfoobar.rst` is `foobar`. directory where the rst file is. For instance, the category of
`python/foobar/myfoobar.rst` is `foobar`.
Features Features
-------- --------
@ -54,8 +55,8 @@ Pelican currently supports:
Getting started — Generate your blog Getting started — Generate your blog
------------------------------------- -------------------------------------
Yeah? You're ready? Let's go ! You can install pelican in a lot of different You're ready? Let's go ! You can install pelican in a lot of different ways,
ways, the simpler one is via pip:: the simpler one is via `pip <http://pip.openplans.org/>`_.
$ pip install pelican $ pip install pelican
@ -63,7 +64,7 @@ Then, you have just to launch pelican, like this::
$ pelican /path/to/your/content/ $ pelican /path/to/your/content/
And… that's all! You can see your weblog generated on the content/ folder. And… that's all! You can see your weblog generated on the `content/` folder.
This one will just generate a simple output, with the default theme. It's not This one will just generate a simple output, with the default theme. It's not
really sexy, as it's a simple HTML output (without any style). really sexy, as it's a simple HTML output (without any style).
@ -76,33 +77,43 @@ the options you can use::
Settings Settings
-------- --------
Pelican try to be configurable via a configuration file, that you can pass to Pelican is configurable thanks a configuration file, that you can pass to
the command line. Here are the settings you can use, with some basic the command line::
description.
Please note that all the settings you put in this file will be passed to the $ pelican -s path/to/your/settingsfile.py path
templates as well.
* `SITEURL` is the base URL of your website. Here are the available settings. Please note that all the settings you put in
* `PATH` is the path to look at for input files. this file will be passed to the templates as well.
* `THEME`: the theme to use to product the output. can be the complete static
path to a theme folder, or choosed between the default pelican themes (see ======================= =======================================================
below) Setting name what it does ?
* `OUTPUT_PATH`: Where to output the generated files. Default to "output" ======================= =======================================================
* `SITENAME`: Your site name, `SITEURL` base URL of your website.
* `DISPLAY_PAGES_ON_MENU`: Display or not the pages on the menu of the `PATH` path to look at for input files.
template. Templates can follow or not this settings. `THEME` theme to use to product the output. can be the
* `PDF_PROCESSOR`: Put True if you want to have PDF outputs as well as HTML complete static path to a theme folder, or choosed
pages, between the list of default themes (see below)
* `DEFAULT_CATEGORY`: The default category. `misc` by default. `OUTPUT_PATH` Where to output the generated files. Default to
* `FALLBACK_ON_FS_DATE`: Choose to fallback on filesystem dates informations if "output"
any other way to retreive the date currrently exists., `SITENAME` Your site name,
* `MARKUP`: A list of available markup languages you want to use. At the `DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template.
moment, only available values are `rst` and `md`. Templates can follow or not this settings.
* `STATIC_PATHS`: The static paths you want to copy under "static" `PDF_PROCESSOR` Put True if you want to have PDF versions of your
* `FEED`: url to output the feed., documents. You will need to install `rst2pdf`.
* `CATEGORY_FEED`: Where to put the categories feeds. default is `feeds/%s.atom.xml` `DEFAULT_CATEGORY` The default category to fallback on. `misc` by default.
* `CSS_FILE`: To specify the CSS file you want to load. `FALLBACK_ON_FS_DATE` If True, pelican will use the filesystem dates infos
(mtime) if it can't get informations from the
metadatas?
`MARKUP` A list of available markup languages you want to use.
moment, only available values are `rst` and `md`.
`STATIC_PATHS` The static paths you want to copy under "static"
`FEED` relative url to output the feed. Default is
`feeds/all.atom.xml`
`CATEGORY_FEED` Where to put the categories feeds. default is
`feeds/%s.atom.xml`
`CSS_FILE` To specify the CSS file you want to load, if it's not
the default one ('main.css')
======================= =======================================================
Themes Themes
------ ------
@ -110,20 +121,28 @@ Themes
3 themes are available. You can specify them using the `-t` option: 3 themes are available. You can specify them using the `-t` option:
* notmyidea * notmyidea
* default * simple (a synonym for "full text" :)
* martyalchin * martyalchin
You can define your own theme too, and specify it's emplacement in the same You can define your own theme too, and specify it's emplacement in the same
way. way (be sure to specify the full absolute path to it).
The `notmyidea` theme can make good use of the following settings: The `notmyidea` theme can make good use of the following settings. I recommand
to use them too in your themes.
* `GITHUB_URL` = your github URL (if you have one) ======================= =======================================================
* `DISQUS_SITENAME` can handle disqus comments Setting name what it does ?
* `LINKS` is a list of tuples Title, Url, for links ======================= =======================================================
* `SOCIAL` (('twitter', 'yourtwitter complete url'),) and any other name/link `GITHUB_URL` Your github URL (if you have one), it will then
you want to put under "social" use it to create a github ribbon.
* `GOOGLE_ANALYTICS` = 'UA-XXXX-YYYY' to activate google analytics. `DISQUS_SITENAME` Pelican can handle disqus comments, specify the
sitename you've filled in on disqus
`LINKS` A list of tuples (Title, Url) for links to appear on
the header.
`SOCIAL` A list of tuples (Title, Url) to appear in the "social"
section.
`GOOGLE_ANALYTICS` 'UA-XXXX-YYYY' to activate google analytics.
======================= =======================================================
In addition, you can use the "wide" version of the `notmyidea` theme, by In addition, you can use the "wide" version of the `notmyidea` theme, by
adding that in your configuration:: adding that in your configuration::
@ -163,14 +182,3 @@ If you want to see new features in Pelican, dont hesitate to tell me, to clone
the repository, etc. That's open source, dude! the repository, etc. That's open source, dude!
Contact me at "alexis at notmyidea dot org" for any request/feedback ! Contact me at "alexis at notmyidea dot org" for any request/feedback !
FAQ
---
How can I specify the url of my website ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configure the `SITEURL` to your site base url, let's say
`http://myswebsite.tld`, in your settings file::
SITEURL = "http://mywebsite.tld"