Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the commondoc-markdown Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:29:22 2022 GMT+0.
Next: Systems, Previous: The commondoc-markdown Reference Manual, Up: The commondoc-markdown Reference Manual [Contents][Index]
This is a wrapper around 3BMD markdown parser which produces documents in CommonDoc format. Also, it is able to render CommonDoc documents into the Markdown.
It is a proof of the concept, but I'm already using it in the documentation builder 40ANTS-DOC.
Note. This library is not compatible with CommonMark yet.
This library available only at Ultralisp.org now. To install it using Quicklisp client, do:
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :commondoc-markdown)
CL-USER> (common-doc.format:parse-document
(make-instance 'commondoc-markdown:markdown)
"
# Hello World
* First item
* Second item
")
#<COMMON-DOC:SECTION title: Hello World, ref: NIL>
Now we can render our document back to Markdown:
CL-USER> (common-doc.format:emit-to-string
(make-instance 'commondoc-markdown:markdown)
*document*)
"# Hello World
* First item
* Second item
"
commondoc-markdown/emitter:*generate-short-link-references* tBy default it is T, but you can bind it to NIL,
to prevent short link references generation.
commondoc-markdown/emitter:*min-link-hash-length* 4Minumum length of the hash for generated markdown links.
This works only when *generate-short-link-references* variable
is set to T.
commondoc-markdown/emitter:*emit-section-anchors* tWhen this variable is T (default), emitter outputs
a raw html <a name="some-id"></a> before each
Markdown section.
Next: Files, Previous: Introduction, Up: The commondoc-markdown Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: commondoc-markdown/core, Previous: Systems, Up: Systems [Contents][Index]
Converter from Markdown to CommonDoc.
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Next: commondoc-markdown/addons, Previous: commondoc-markdown, Up: Systems [Contents][Index]
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Next: commondoc-markdown/format, Previous: commondoc-markdown/core, Up: Systems [Contents][Index]
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Next: commondoc-markdown/raw-html, Previous: commondoc-markdown/addons, Up: Systems [Contents][Index]
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Next: commondoc-markdown/emitter, Previous: commondoc-markdown/format, Up: Systems [Contents][Index]
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Previous: commondoc-markdown/raw-html, Up: Systems [Contents][Index]
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
Next: Packages, Previous: Systems, Up: The commondoc-markdown Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: commondoc-markdown/core/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
commondoc-markdown (system).
Next: commondoc-markdown/addons/file-type.lisp, Previous: commondoc-markdown/commondoc-markdown.asd, Up: Lisp [Contents][Index]
commondoc-markdown/core (system).
Next: commondoc-markdown/format/file-type.lisp, Previous: commondoc-markdown/core/file-type.lisp, Up: Lisp [Contents][Index]
commondoc-markdown/addons (system).
*strikethrough* (special variable).
Next: commondoc-markdown/raw-html/file-type.lisp, Previous: commondoc-markdown/addons/file-type.lisp, Up: Lisp [Contents][Index]
commondoc-markdown/format (system).
markdown (class).
Next: commondoc-markdown/emitter/file-type.lisp, Previous: commondoc-markdown/format/file-type.lisp, Up: Lisp [Contents][Index]
commondoc-markdown/raw-html (system).
Previous: commondoc-markdown/raw-html/file-type.lisp, Up: Lisp [Contents][Index]
commondoc-markdown/emitter (system).
Next: Definitions, Previous: Files, Up: The commondoc-markdown Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: commondoc-markdown/raw-html, Previous: Packages, Up: Packages [Contents][Index]
common-lisp.
Next: commondoc-markdown/format, Previous: commondoc-markdown/emitter, Up: Packages [Contents][Index]
common-lisp.
Next: commondoc-markdown, Previous: commondoc-markdown/raw-html, Up: Packages [Contents][Index]
common-lisp.
markdown (class).
Next: commondoc-markdown/addons, Previous: commondoc-markdown/format, Up: Packages [Contents][Index]
commondoc-markdown/core
common-lisp.
Previous: commondoc-markdown, Up: Packages [Contents][Index]
common-lisp.
*strikethrough* (special variable).
Next: Indexes, Previous: Packages, Up: The commondoc-markdown Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
When this variable is ‘T‘ (default), emitter outputs a raw html ‘<a name="some-id"></a>‘ before each Markdown section.
By default it is ‘T‘, but you can bind it to NIL, to prevent short link references generation.
Minumum length of the hash for generated markdown links.
This works only when *GENERATE-SHORT-LINK-REFERENCES* variable
is set to ‘T‘.
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
A definition slug for the linked document.
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.format.
common-doc.ops.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
The Markdown format.
document-format.
A named link like [Some text][the-id].
These links can be replaced with a web-link if id is defined somewhere in the markdown text.
link.
A definition slug for the linked document.
(or null string)
:definition
document-node.
html.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Standalone methods, Previous: Macros, Up: Internals [Contents][Index]
If code includes examples of markdown code blocks, then we should
select higher number of backticks.
This function returns a number of backticks, required to wrap given CODE-TEXT into a Markdown code-block.
PIECES argument may contain a strings
or lists like (:CODE "foo").
Consecutive strings are concatenated into a text nodes, for lists a CREATE-NODE function is applied
This is just a helper to reuse in tests
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
common-html.emitter.
common-html.emitter.
common-html.emitter.
Previous: Standalone methods, Up: Internals [Contents][Index]
Explicit line break. In Markdown you have to add two or more spaces at the end of the line.
When rendered to HTML, this node will be replaced with <br/>.
When rendered back to markdown - with two spaces and a new-line.
markup.
Previous: Definitions, Up: The commondoc-markdown Reference Manual [Contents][Index]
| Jump to: | (
C E F G H M N P W |
|---|
| Jump to: | (
C E F G H M N P W |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | *
D H S |
|---|
| Jump to: | *
D H S |
|---|
| Jump to: | C F L M P R S |
|---|
| Jump to: | C F L M P R S |
|---|