mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Add asciidoc reader support
http://www.methods.co.nz/asciidoc/index.html Processes files ending in .asc with asciidoc. Extra arguments can be passed by using the ASCIIDOC_OPTIONS config setting
This commit is contained in:
parent
f9e7c86a1a
commit
49f481e399
9 changed files with 114 additions and 6 deletions
|
|
@ -24,6 +24,7 @@ Release history
|
|||
* Add the gzip_cache plugin which compresses common text files into a ``.gz``
|
||||
file within the same directory as the original file to prevent the server
|
||||
(e.g. Nginx) from compressing files during an HTTP call.
|
||||
* Add AsciiDoc support
|
||||
|
||||
3.0 (2012-08-08)
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -42,6 +42,10 @@ Markdown library as well::
|
|||
|
||||
$ pip install Markdown
|
||||
|
||||
If you want to use AsciiDoc you need to install it from `source
|
||||
<http://www.methods.co.nz/asciidoc/INSTALL.html>`_ or use your operating
|
||||
system's package manager.
|
||||
|
||||
Upgrading
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Pelican
|
|||
Pelican is a static site generator, written in Python_.
|
||||
|
||||
* Write your weblog entries directly with your editor of choice (vim!)
|
||||
in reStructuredText_ or Markdown_
|
||||
in reStructuredText_, Markdown_ or AsciiDoc_
|
||||
* 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
|
||||
|
|
@ -74,6 +74,7 @@ A French version of the documentation is available at :doc:`fr/index`.
|
|||
.. _Python: http://www.python.org/
|
||||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||||
.. _Markdown: http://daringfireball.net/projects/markdown/
|
||||
.. _AsciiDoc: http://www.methods.co.nz/asciidoc/index.html
|
||||
.. _Jinja2: http://jinja.pocoo.org/
|
||||
.. _`Pelican documentation`: http://docs.getpelican.com/latest/
|
||||
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ original author wrote with some software design information.
|
|||
Overall structure
|
||||
=================
|
||||
|
||||
What Pelican does is take a list of files and process them into some
|
||||
sort of output. Usually, the input files are reStructuredText and Markdown
|
||||
What Pelican does is take a list of files and process them into some sort of
|
||||
output. Usually, the input files are reStructuredText, Markdown and AsciiDoc
|
||||
files, and the output is a blog, but both input and output can be anything you
|
||||
want.
|
||||
|
||||
|
|
@ -23,9 +23,9 @@ The logic is separated into different classes and concepts:
|
|||
on. Since those operations are commonly used, the object is created once and
|
||||
then passed to the generators.
|
||||
|
||||
* **Readers** are used to read from various formats (Markdown and
|
||||
reStructuredText for now, but the system is extensible). Given a file, they return
|
||||
metadata (author, tags, category, etc.) and content (HTML-formatted).
|
||||
* **Readers** are used to read from various formats (AsciiDoc, Markdown and
|
||||
reStructuredText for now, but the system is extensible). Given a file, they
|
||||
return metadata (author, tags, category, etc.) and content (HTML-formatted).
|
||||
|
||||
* **Generators** generate the different outputs. For instance, Pelican comes with
|
||||
``ArticlesGenerator`` and ``PageGenerator``. Given a configuration, they can do
|
||||
|
|
|
|||
|
|
@ -121,6 +121,8 @@ Setting name (default value) What doe
|
|||
This templates need to use ``DIRECT_TEMPLATES`` setting
|
||||
|
||||
`MARKDOWN_EXTENSIONS` (``['toc',]``) A list of any Markdown extensions you want to use.
|
||||
`ASCIIDOC_OPTIONS` (``[]``) A list of options to pass to asciidoc, see the `manpage
|
||||
<http://www.methods.co.nz/asciidoc/manpage.html>`_
|
||||
===================================================================== =====================================================================
|
||||
|
||||
.. [#] Default is the system locale.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue