forked from github/pelican
Minor documentation improvements
This commit is contained in:
Justin Mayer
parent
7b0165696e
commit
8be7c0dbae
6 changed files with 31 additions and 31 deletions
|
|
@ -26,7 +26,7 @@ different projects.
|
|||
|
||||
To create and activate a virtual environment, use the following syntax::
|
||||
|
||||
$ virtualenv pelican ~/virtualenvs/pelican
|
||||
$ virtualenv ~/virtualenvs/pelican
|
||||
$ cd ~/virtualenvs/pelican
|
||||
$ . bin/activate
|
||||
|
||||
|
|
|
|||
24
docs/faq.rst
24
docs/faq.rst
|
|
@ -10,11 +10,11 @@ If you have a problem, question, or suggestion, please start by striking up a
|
|||
conversation on `#pelican on Freenode <irc://irc.freenode.net/pelican>`_.
|
||||
Those who don't have an IRC client handy can jump in immediately via
|
||||
`IRC webchat <http://webchat.freenode.net/?channels=pelican&uio=d4>`_. Because
|
||||
of differing time zones, you may not get an immediate response to your question,
|
||||
but please be patient and stay logged into IRC — someone will almost always
|
||||
respond if you wait long enough (it may take a few hours).
|
||||
of differing time zones, you may not get an immediate response to your
|
||||
question, but please be patient and stay logged into IRC — someone will almost
|
||||
always respond if you wait long enough (it may take a few hours).
|
||||
|
||||
If you are unable to resolve your issue or if you have a feature request, please
|
||||
If you're unable to resolve your issue or if you have a feature request, please
|
||||
refer to the `issue tracker <https://github.com/getpelican/pelican/issues>`_.
|
||||
|
||||
How can I help?
|
||||
|
|
@ -28,9 +28,9 @@ a duplicate issue.
|
|||
|
||||
If you want to contribute, please fork `the git repository
|
||||
<https://github.com/getpelican/pelican/>`_, 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 :doc:`How to Contribute <contribute>` section
|
||||
for more details.
|
||||
your changes, and issue a pull request. Someone will review your changes as
|
||||
soon as possible. Please refer to the :doc:`How to Contribute <contribute>`
|
||||
section for more details.
|
||||
|
||||
You can also contribute by creating themes and improving the documentation.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ If you don't have ``pip`` installed, consider installing it via::
|
|||
|
||||
easy_install pip
|
||||
|
||||
Can I use arbitrary meta-data in my templates?
|
||||
Can I use arbitrary metadata in my templates?
|
||||
==============================================
|
||||
|
||||
Yes. For example, to include a modified date in a Markdown post, one could
|
||||
|
|
@ -77,7 +77,7 @@ include the following at the top of the article::
|
|||
|
||||
Modified: 2012-08-08
|
||||
|
||||
That meta-data can then be accessed in the template::
|
||||
That metadata can then be accessed in the template::
|
||||
|
||||
{% if article.modified %}
|
||||
Last modified: {{ article.modified }}
|
||||
|
|
@ -86,7 +86,7 @@ That meta-data can then be accessed in the template::
|
|||
How do I assign custom templates on a per-page basis?
|
||||
=====================================================
|
||||
|
||||
It's as simple as adding an extra line of meta-data to any pages or articles
|
||||
It's as simple as adding an extra line of metadata to any page or article that
|
||||
you want to have its own template. For example, this is how it would be handled
|
||||
for content in reST format::
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ Then just make sure your theme contains the relevant template file (e.g.
|
|||
How can I override the generated URL of a specific page or article?
|
||||
===================================================================
|
||||
|
||||
Include ``url`` and ``save_as`` meta-data in any pages or articles that you want
|
||||
Include ``url`` and ``save_as`` metadata in any pages or articles that you want
|
||||
to override the generated URL. Here is an example page in reST format::
|
||||
|
||||
Override url/save_as page
|
||||
|
|
@ -111,7 +111,7 @@ to override the generated URL. Here is an example page in reST format::
|
|||
:url: override/url/
|
||||
:save_as: override/url/index.html
|
||||
|
||||
With this meta-data, the page will be written to ``override/url/index.html``
|
||||
With this metadata, the page will be written to ``override/url/index.html``
|
||||
and Pelican will use url ``override/url/`` to link to this page.
|
||||
|
||||
How can I use a static page as my home page?
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Description
|
|||
===========
|
||||
|
||||
``pelican-import`` is a command-line tool for converting articles from other
|
||||
software to ReStructuredText or Markdown. The supported import formats are:
|
||||
software to reStructuredText or Markdown. The supported import formats are:
|
||||
|
||||
- WordPress XML export
|
||||
- Dotclear export
|
||||
|
|
@ -24,7 +24,7 @@ not be converted (as Pelican also supports Markdown).
|
|||
Dependencies
|
||||
============
|
||||
|
||||
``pelican-import`` has some dependencies not required by the rest of pelican:
|
||||
``pelican-import`` has some dependencies not required by the rest of Pelican:
|
||||
|
||||
- *BeautifulSoup*, for WordPress and Dotclear import. Can be installed like
|
||||
any other Python package (``pip install BeautifulSoup``).
|
||||
|
|
@ -95,6 +95,7 @@ for Posterous::
|
|||
|
||||
$ pelican-import --posterous -o ~/output --email=<email_address> --password=<password> <api_token>
|
||||
|
||||
|
||||
Tests
|
||||
=====
|
||||
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@ Pelican
|
|||
|
||||
Pelican is a static site generator, written in Python_.
|
||||
|
||||
* Write your weblog entries directly with your editor of choice (vim!)
|
||||
in reStructuredText_, Markdown_, or AsciiDoc_
|
||||
* Includes a simple CLI tool to (re)generate the weblog
|
||||
* Easy to interface with DVCSes and web hooks
|
||||
* Write your content directly with your editor of choice (vim!)
|
||||
in reStructuredText_, Markdown_, or AsciiDoc_ 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
|
||||
|
||||
Features
|
||||
|
|
@ -14,15 +14,15 @@ Features
|
|||
|
||||
Pelican currently supports:
|
||||
|
||||
* Blog articles and pages
|
||||
* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
|
||||
* 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_ templates)
|
||||
* PDF generation of the articles/pages (optional)
|
||||
* Publication of articles in multiple languages
|
||||
* Atom/RSS feeds
|
||||
* Code syntax highlighting
|
||||
* PDF generation of the articles/pages (optional)
|
||||
* Import from WordPress, Dotclear, or RSS feeds
|
||||
* Integration with external tools: Twitter, Google Analytics, etc. (optional)
|
||||
|
||||
|
|
|
|||
|
|
@ -30,13 +30,14 @@ the settings file::
|
|||
Where to find plugins
|
||||
=====================
|
||||
|
||||
We maintain a separate repository of plugins for people to share and use.
|
||||
Please see the `pelican-plugins`_ repository for the official place for plugins.
|
||||
We maintain a separate repository of plugins for people to share and use.
|
||||
Please visit the `pelican-plugins`_ repository for a list of available plugins.
|
||||
|
||||
.. _pelican-plugins: https://github.com/getpelican/pelican-plugins
|
||||
|
||||
Please note that while we will give best effort, the submitted plugins are all
|
||||
community driven and supported.
|
||||
Please note that while we do our best to review and maintain these plugins,
|
||||
they are submitted by the Pelican community and thus may have varying levels of
|
||||
support and interoperability.
|
||||
|
||||
How to create plugins
|
||||
=====================
|
||||
|
|
@ -56,8 +57,6 @@ which you map the signals to your plugin logic. Let's take a simple example::
|
|||
def register():
|
||||
signals.initialized.connect(test)
|
||||
|
||||
|
||||
|
||||
List of signals
|
||||
===============
|
||||
|
||||
|
|
|
|||
|
|
@ -269,10 +269,10 @@ Have a look at `the wikipedia page`_ to get a list of valid timezone values.
|
|||
Date format and locale
|
||||
----------------------
|
||||
|
||||
If no DATE_FORMATS is set, fall back to DEFAULT_DATE_FORMAT. If you need to
|
||||
maintain multiple languages with different date formats, you can set this dict
|
||||
using language name (``lang`` in your posts) as key. Regarding available format
|
||||
codes, see `strftime document of python`_ :
|
||||
If no DATE_FORMATS are set, Pelican will fall back to DEFAULT_DATE_FORMAT. If
|
||||
you need to maintain multiple languages with different date formats, you can
|
||||
set this dict using the language name (``lang`` metadata in your post content)
|
||||
as the key. Regarding available format codes, see `strftime document of python`_ :
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue