Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the commondoc-markdown Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:30:35 2022 GMT+0.
| • Introduction | What commondoc-markdown is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
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: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: The commondoc-markdown/emitter system, Previous: Systems, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
Converter from Markdown to CommonDoc.
commondoc-markdown.asd (file)
Next: The commondoc-markdown/core system, Previous: The commondoc-markdown system, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
commondoc-markdown.asd (file)
file-type.lisp (file)
Next: The commondoc-markdown/addons system, Previous: The commondoc-markdown/emitter system, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
commondoc-markdown.asd (file)
file-type.lisp (file)
Next: The commondoc-markdown/raw-html system, Previous: The commondoc-markdown/core system, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
commondoc-markdown.asd (file)
file-type.lisp (file)
Next: The commondoc-markdown/format system, Previous: The commondoc-markdown/addons system, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
commondoc-markdown.asd (file)
file-type.lisp (file)
Previous: The commondoc-markdown/raw-html system, Up: Systems [Contents][Index]
Alexander Artemenko
(:git "https://github.com/40ants/commondoc-markdown")
Unlicense
commondoc-markdown.asd (file)
file-type.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
Next: The commondoc-markdown/emitter/file-type․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
/home/quickref/quicklisp/dists/quicklisp/software/commondoc-markdown-20220331-git/commondoc-markdown.asd
Next: The commondoc-markdown/core/file-type․lisp file, Previous: The commondoc-markdown․asd file, Up: Lisp files [Contents][Index]
commondoc-markdown/emitter (system)
emitter.lisp
Next: The commondoc-markdown/addons/file-type․lisp file, Previous: The commondoc-markdown/emitter/file-type․lisp file, Up: Lisp files [Contents][Index]
commondoc-markdown/core (system)
core.lisp
Next: The commondoc-markdown/raw-html/file-type․lisp file, Previous: The commondoc-markdown/core/file-type․lisp file, Up: Lisp files [Contents][Index]
commondoc-markdown/addons (system)
addons.lisp
*strikethrough* (special variable)
Next: The commondoc-markdown/format/file-type․lisp file, Previous: The commondoc-markdown/addons/file-type․lisp file, Up: Lisp files [Contents][Index]
commondoc-markdown/raw-html (system)
raw-html.lisp
Previous: The commondoc-markdown/raw-html/file-type․lisp file, Up: Lisp files [Contents][Index]
commondoc-markdown/format (system)
format.lisp
markdown (class)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The commondoc-markdown/emitter package | ||
| • The commondoc-markdown package | ||
| • The commondoc-markdown/addons package | ||
| • The commondoc-markdown/raw-html package | ||
| • The commondoc-markdown/format package |
Next: The commondoc-markdown package, Previous: Packages, Up: Packages [Contents][Index]
file-type.lisp (file)
common-lisp
Next: The commondoc-markdown/addons package, Previous: The commondoc-markdown/emitter package, Up: Packages [Contents][Index]
file-type.lisp (file)
commondoc-markdown/core
common-lisp
Next: The commondoc-markdown/raw-html package, Previous: The commondoc-markdown package, Up: Packages [Contents][Index]
file-type.lisp (file)
common-lisp
*strikethrough* (special variable)
Next: The commondoc-markdown/format package, Previous: The commondoc-markdown/addons package, Up: Packages [Contents][Index]
file-type.lisp (file)
common-lisp
Previous: The commondoc-markdown/raw-html package, Up: Packages [Contents][Index]
file-type.lisp (file)
common-lisp
markdown (class)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables | ||
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
When this variable is ‘T‘ (default), emitter outputs a raw html ‘<a name="some-id"></a>‘ before each Markdown section.
file-type.lisp (file)
By default it is ‘T‘, but you can bind it to NIL, to prevent short link references generation.
file-type.lisp (file)
Minumum length of the hash for generated markdown links.
This works only when *GENERATE-SHORT-LINK-REFERENCES* variable
is set to ‘T‘.
file-type.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
file-type.lisp (file)
A definition slug for the linked document.
file-type.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
The Markdown format.
file-type.lisp (file)
document-format (class)
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.
file-type.lisp (file)
link (class)
A definition slug for the linked document.
(or null string)
:definition
markdown-link-definition (generic function)
(setf markdown-link-definition) (generic function)
file-type.lisp (file)
document-node (class)
html (method)
string
:html
html (generic function)
file-type.lisp (file)
raw-html (class)
file-type.lisp (file)
raw-html (class)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
file-type.lisp (file)
file-type.lisp (file)
Next: Internal classes, Previous: Internal macros, Up: Internal definitions [Contents][Index]
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
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.
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
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
file-type.lisp (file)
This is just a helper to reuse in tests
file-type.lisp (file)
file-type.lisp (file)
file-type.lisp (file)
Previous: Internal functions, Up: Internal definitions [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.
file-type.lisp (file)
markup (class)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
C F G H M P W |
|---|
| Jump to: | (
C F G H M P W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
D H S |
|---|
| Jump to: | *
D H S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C L M P R S |
|---|
| Jump to: | C L M P R S |
|---|