jeffrimko e0dc2271d5 Added fix for Unicode problems reported in issue #995. 6 years ago
..
test_data ad6d40715e Updated AsciiDoc reader to support both legacy and asciidoctor CLI utilities. 6 years ago
README.rst ad6d40715e Updated AsciiDoc reader to support both legacy and asciidoctor CLI utilities. 6 years ago
__init__.py fc3a4d8993 import AsciiDocReader from core as a plugin 10 years ago
asciidoc_reader.py e0dc2271d5 Added fix for Unicode problems reported in issue #995. 6 years ago
test_asciidoc_reader.py ad6d40715e Updated AsciiDoc reader to support both legacy and asciidoctor CLI utilities. 6 years ago

README.rst

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

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

Dependency
----------

There are two command line utilities commonly used to render AsciiDoc:
``asciidoc`` and ``asciidoctor``. One of the two will need to be installed and
on the PATH.

**Note**: The ``asciidoctor`` utility is recommended since the original
``asciidoc`` is no longer maintained.

Settings
--------

======================================== =======================================================
Setting name (followed by default value) What does it do?
======================================== =======================================================
``ASCIIDOC_CMD = asciidoc`` Selects which utility to use for rendering. Will
autodetect utility if not provided.
``ASCIIDOC_OPTIONS = []`` A list of options to pass to AsciiDoc. See the `manpage
`_.
======================================== =======================================================

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...