mirror of
https://github.com/Orc/discount.git
synced 2026-09-25 04:10:00 +03:00
Document mkd_generatetoc(), mkd_xhtmlpage(), --enable-alpha-list
This commit is contained in:
+24
-3
@@ -85,9 +85,10 @@ block level html;
|
||||
.Em <style>
|
||||
starting on column 1, raw html (or, in this case, css) following
|
||||
it, and either ending with a
|
||||
.Em </style> at the end of the line or
|
||||
a
|
||||
.Em </style> at the beginning of a subsequent line.
|
||||
.Em </style>
|
||||
at the end of the line or a
|
||||
.Em </style>
|
||||
at the beginning of a subsequent line.
|
||||
.Pp
|
||||
Be warned that style blocks work like footnote links -- no matter
|
||||
where you define them they are valid for the entire document.
|
||||
@@ -101,6 +102,26 @@ will
|
||||
count as a emphasis character if it's in the middle of a word.
|
||||
This is primarily for documenting code, if you don't wish to
|
||||
have to backquote all code references.
|
||||
.Ss alpha lists
|
||||
If markdown was configured with
|
||||
.Ar --enable-alpha-list ,
|
||||
alphabetic lists (like regular numeric lists, but with alphabetic
|
||||
items) are supported. So:
|
||||
.nf
|
||||
a. this
|
||||
b. is
|
||||
c. an alphabetic
|
||||
d. list
|
||||
.fi
|
||||
will produce:
|
||||
.nf
|
||||
<ol type=a>
|
||||
<li>this</li>
|
||||
<li>is</li>
|
||||
<li>an alphabetic</li>
|
||||
<li>list</li>
|
||||
</ol>
|
||||
.fi
|
||||
.Sh AUTHOR
|
||||
David Parsons
|
||||
.%T http://www.pell.portland.or.us/~orc/
|
||||
|
||||
@@ -18,6 +18,10 @@ Markdown
|
||||
.Fn mkd_document "MMIOT *document" "char **doc"
|
||||
.Ft int
|
||||
.Fn mkd_generatehtml "MMIOT *document" "FILE *output"
|
||||
.Ft int
|
||||
.Fn mkd_xhtmlpage "MMIOT *document" "int flags" "FILE *output"
|
||||
.Ft void
|
||||
.Fn mkd_generatetoc "MMIOT *document" "FILE *output"
|
||||
.Ft void
|
||||
.Fn mkd_cleanup "MMIOT*"
|
||||
.Ft char*
|
||||
@@ -61,6 +65,8 @@ by the
|
||||
.Fn mkd_style ,
|
||||
.Fn mkd_document ,
|
||||
.Fn mkd_generatehtml ,
|
||||
.Fn mkd_generatetoc ,
|
||||
.Fn mkd_xhtmlpage ,
|
||||
.Fn mkd_doc_title ,
|
||||
.Fn mkd_doc_author ,
|
||||
and
|
||||
@@ -83,6 +89,14 @@ and
|
||||
are used to read the contents of a Pandoc header,
|
||||
if any.
|
||||
.Pp
|
||||
.Fn mkd_xhtmlpage
|
||||
writes a xhtml page containing the document. The regular set of
|
||||
flags can be passed.
|
||||
.Pp
|
||||
.Fn mkd_generatetoc
|
||||
Writes a document outline, in the form of a collection of nested
|
||||
lists, with links to each header in the document.
|
||||
.Pp
|
||||
.Fn mkd_cleanup
|
||||
deletes a
|
||||
.Ar MMIOT*
|
||||
|
||||
Reference in New Issue
Block a user