README.rst 1.3 KB

12345678910111213141516171819202122232425262728
  1. AsciiDoc Reader
  2. ###############
  3. This plugin allows you to use `AsciiDoc <http://www.methods.co.nz/asciidoc/>`_
  4. to write your posts. File extension should be ``.asc``, ``.adoc``,
  5. or ``.asciidoc``.
  6. Dependency
  7. ----------
  8. If you want to use AsciiDoc you need to install it from `source
  9. <http://www.methods.co.nz/asciidoc/INSTALL.html>`_ or use your operating
  10. system's package manager.
  11. **Note**: AsciiDoc does not work with Python 3, so you should be using Python 2.
  12. Settings
  13. --------
  14. ======================================== =======================================================
  15. Setting name (followed by default value) What does it do?
  16. ======================================== =======================================================
  17. ``ASCIIDOC_OPTIONS = []`` A list of options to pass to AsciiDoc. See the `manpage
  18. <http://www.methods.co.nz/asciidoc/manpage.html>`_.
  19. ``ASCIIDOC_BACKEND = 'html5'`` Backend format for output. See the `documentation
  20. <http://www.methods.co.nz/asciidoc/userguide.html#X5>`_
  21. for possible values.
  22. ======================================== =======================================================