Browse Source

Add AsciiDoc example

Marco Molteni 8 years ago
parent
commit
3f55c2b773
1 changed files with 22 additions and 1 deletions
  1. 22 1
      asciidoc_reader/README.rst

+ 22 - 1
asciidoc_reader/README.rst

@@ -25,4 +25,25 @@ Setting name (followed by default value)  What does it do?
 ``ASCIIDOC_BACKEND = 'html5'``            Backend format for output. See the `documentation 
                                           <http://www.methods.co.nz/asciidoc/userguide.html#X5>`_
                                           for possible values.
-========================================  =======================================================
+========================================  =======================================================
+
+Example file header
+-------------------
+
+Following the `example <https://github.com/getpelican/pelican/blob/master/docs/content.rst#file-metadata>`_ 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...