diff --git a/README.rst b/README.rst index d93f0a4b..12a98fb8 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ Pelican .. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master -Pelican is a simple weblog generator, written in `Python `_. +Pelican is a static site generator, written in `Python `_. * Write your weblog entries directly with your editor of choice (vim!) in `reStructuredText `_ or `Markdown `_ @@ -20,11 +20,12 @@ Pelican currently supports: * 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 `_) +* Theming support (themes are created using `Jinja2 `_) * PDF generation of the articles/pages (optional) * Publication of articles in multiple languages * Atom/RSS feeds * Code syntax highlighting +* Compilation of `LESS CSS `_ (optional) * Import from WordPress, Dotclear, or RSS feeds * Integration with external tools: Twitter, Google Analytics, etc. (optional) @@ -34,26 +35,26 @@ more information. Why the name "Pelican"? ------------------------ -Heh, you didn't notice? "Pelican" is an anagram for « Calepin » ;) +"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;) Source code ----------- -You can access the source code via git at: https://github.com/getpelican/pelican +You can access the source code at: https://github.com/getpelican/pelican If you feel hackish, have a look at the explanation of `Pelican's internals -`_. +`_. 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 `contribute -`_. That's open source, dude! +`_. That's open source, dude! -Contact me at "alexis at notmyidea dot org" for any request/feedback! You can -also join the team at `#pelican on irc.freenode.org -`_ -(or if you don't have any IRC client, use `the webchat +Send a message to "alexis at notmyidea dot org" with any requests/feedback! You +can also join the team at +`#pelican on Freenode `_ (or if you don't have +a IRC client handy, use `the webchat `_) for quick feedback. diff --git a/docs/changelog.rst b/docs/changelog.rst index da77f97e..f6365d75 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -2,7 +2,7 @@ Release history ############### 3.0.0 (XXXX-XX-XX) -================ +================== * Refactored the way URLs are handled * Improved the English documentation @@ -20,7 +20,7 @@ Release history * Fixed a bunch of bugs :-) 2.8.0 (2012-02-28) -================ +================== * Dotclear importer * Allow the usage of Markdown extensions diff --git a/docs/faq.rst b/docs/faq.rst index 542d1b74..dd7428eb 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -26,7 +26,8 @@ suggestions or problems you might have via IRC or the issue tracker. If you want to contribute, please fork `the git repository `_, create a new feature branch, make your changes, and issue a pull request. Someone will review your changes as soon -as possible. Please refer to the :ref:`contribute` section for more details. +as possible. Please refer to the :doc:`How to Contribute ` section +for more details. You can also contribute by creating themes and improving the documentation. diff --git a/docs/index.rst b/docs/index.rst index 711f28bc..196d9de1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,11 @@ Pelican ####### -Pelican is a static site generator, written in Python. +Pelican is a static site generator, written in `Python `_. -* Write your weblog entries directly with your editor of choice (vim!) in - reStructuredText or Markdown -* A simple CLI tool to (re)generate the weblog +* Write your weblog entries directly with your editor of choice (vim!) + in `reStructuredText `_ or `Markdown `_ +* Includes a simple CLI tool to (re)generate the weblog * Easy to interface with DVCSes and web hooks * Completely static output is easy to host anywhere @@ -30,18 +30,19 @@ Pelican currently supports: Why the name "Pelican"? ======================== -Heh, you didn't notice? "Pelican" is an anagram for « Calepin » ;) +"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;) Source code =========== -You can access the source code at: http://github.com/getpelican/pelican/ +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 chime in, clone -the repository, etc. That's open source, dude! +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`. +That's open source, dude! Send a message to "alexis at notmyidea dot org" with any requests/feedback! You can also join the team at diff --git a/docs/settings.rst b/docs/settings.rst index 9ea6071d..c219ed12 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -468,7 +468,7 @@ template tag, for example: .. code-block:: jinja {% assets filters="cssmin", output="css/style.min.css", "css/inuit.css", "css/pygment-monokai.css", "css/main.css" %} - + {% endassets %} will produce a minified css file with the version identifier: