diff options
author | David Marble <davidmarble@gmail.com> | 2012-08-23 18:31:45 -0700 |
---|---|---|
committer | David Marble <davidmarble@gmail.com> | 2012-08-23 18:31:45 -0700 |
commit | 831e1d04b98e872770af578bc3bedc84d42cd933 (patch) | |
tree | 85eddbe13b32b06ad97d095c96f928e80ca048e9 | |
parent | 8ecebc9310e48555e2245336adff7e41dd90874a (diff) | |
download | pelican-831e1d04b98e872770af578bc3bedc84d42cd933.tar.gz |
docs: Pelican outputs to output/ not content/. Markdown ::: syntax must be indented
-rw-r--r-- | docs/getting_started.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 282d6c23..b7cbe951 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -186,7 +186,7 @@ the content. The ``pelican`` command can also be run directly:: $ pelican /path/to/your/content/ [-s path/to/your/settings.py] -The above command will generate your weblog and save it in the ``content/`` +The above command will generate your weblog and save it in the ``output/`` folder, using the default theme to produce a simple site. The default theme is simple HTML without styling and is provided so folks may use it as a basis for creating their own themes. @@ -271,19 +271,21 @@ Pelican is able to provide colorized syntax highlighting for your code blocks. To do so, you have to use the following conventions (you need to put this in your content files). -For RestructuredText:: +For RestructuredText, use the code-block directive:: .. code-block:: identifier - your code goes here + <indented code block goes here> -For Markdown, format your code blocks thusly:: +For Markdown, include the language identifier just above code blocks:: - :::identifier - your code goes here + :::identifier + <code goes here> + + (indent both the identifier and code) -The specified identifier should be one that appears on the -`list of available lexers <http://pygments.org/docs/lexers/>`_. +The specified identifier (e.g. ``python``, ``ruby``) should be one that +appears on the `list of available lexers <http://pygments.org/docs/lexers/>`_. Publishing drafts ----------------- |