Marco Molteni 3f55c2b773 Add AsciiDoc example 8 년 전
..
test_data fc3a4d8993 import AsciiDocReader from core as a plugin 10 년 전
README.rst 3f55c2b773 Add AsciiDoc example 8 년 전
__init__.py fc3a4d8993 import AsciiDocReader from core as a plugin 10 년 전
asciidoc_reader.py e92903a172 Don't add empty metadata values 8 년 전
asciidocapi.py fc3a4d8993 import AsciiDocReader from core as a plugin 10 년 전
test_asciidoc_reader.py 1adddd4682 Fix parsing of AsciiDoc attribute values by converting to unicode. 9 년 전

README.rst

AsciiDoc Reader
###############

This plugin allows you to use `AsciiDoc `_
to write your posts. File extension should be ``.asc``, ``.adoc``,
or ``.asciidoc``.

Dependency
----------

If you want to use AsciiDoc you need to install it from `source
`_ or use your operating
system's package manager.

**Note**: AsciiDoc does not work with Python 3, so you should be using Python 2.

Settings
--------

======================================== =======================================================
Setting name (followed by default value) What does it do?
======================================== =======================================================
``ASCIIDOC_OPTIONS = []`` A list of options to pass to AsciiDoc. See the `manpage
`_.
``ASCIIDOC_BACKEND = 'html5'`` Backend format for output. See the `documentation
`_
for possible values.
======================================== =======================================================

Example file header
-------------------

Following the `example `_ in the main pelican documentation:

.. code-block:: none

= My super title

:date: 2010-10-03 10:20
:modified: 2010-10-04 18:40
:tags: thats, awesome
:category: yeah
:slug: my-super-post
:authors: Alexis Metaireau, Conan Doyle
:summary: Short version for index and feeds

== title level 2

and so on...