This is the commondoc-markdown Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:48:36 2024 GMT+0.
commondoc-markdown/commondoc-markdown.asdcommondoc-markdown/core/file-type.lispcommondoc-markdown/addons/file-type.lispcommondoc-markdown/format/file-type.lispcommondoc-markdown/raw-html/file-type.lispcommondoc-markdown/utils/file-type.lispcommondoc-markdown/emitter/file-type.lispThe main system appears first, followed by any subsystem dependency.
commondoc-markdowncommondoc-markdown/corecommondoc-markdown/addonscommondoc-markdown/formatcommondoc-markdown/raw-htmlcommondoc-markdown/utilscommondoc-markdown/emittercommondoc-markdownConverter from Markdown to CommonDoc.
Alexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
uiop (system).
3bmd (system).
3bmd-ext-code-blocks (system).
commondoc-markdown/core (system).
commondoc-markdown/emitter (system).
commondoc-markdown/coreAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
commondoc-markdown/addons (system).
3bmd (system).
3bmd (system).
3bmd-ext-code-blocks (system).
3bmd-ext-tables (system).
common-doc (system).
common-doc (system).
common-doc (system).
plump (system).
commondoc-markdown/format (system).
commondoc-markdown/raw-html (system).
commondoc-markdown/utils (system).
commondoc-markdown/addonsAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
3bmd (system).
esrap (system).
commondoc-markdown/formatAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
common-doc (system).
commondoc-markdown/raw-htmlAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
common-doc (system).
common-doc (system).
commondoc-markdown/format (system).
common-html (system).
commondoc-markdown/utilsAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
str (system).
commondoc-markdown/emitterAlexander Artemenko
(GIT https://github.com/40ants/commondoc-markdown)
Unlicense
commondoc-markdown/core (system).
alexandria (system).
common-html (system).
common-doc (system).
str (system).
ironclad (system).
babel (system).
quri (system).
Files are sorted by type and then listed depth-first from the systems components trees.
commondoc-markdown/commondoc-markdown.asdcommondoc-markdown/core/file-type.lispcommondoc-markdown/addons/file-type.lispcommondoc-markdown/format/file-type.lispcommondoc-markdown/raw-html/file-type.lispcommondoc-markdown/utils/file-type.lispcommondoc-markdown/emitter/file-type.lispcommondoc-markdown/commondoc-markdown.asdcommondoc-markdown (system).
commondoc-markdown/core/file-type.lispcommondoc-markdown/core (system).
make-markdown-link (function).
markdown-link (class).
markdown-link-definition (reader method).
(setf markdown-link-definition) (writer method).
node-specific-equal (method).
parse-document (method).
*create-node-recursive-call* (special variable).
*link-references* (special variable).
*sections-stack* (special variable).
call-with-collected-references (function).
create-node (function).
find-url (function).
go-deeper (macro).
line-break (class).
make-inline-nodes (function).
parse-markdown (function).
with-collected-references (macro).
commondoc-markdown/addons/file-type.lispcommondoc-markdown/addons (system).
*strikethrough* (special variable).
commondoc-markdown/format/file-type.lispcommondoc-markdown/format (system).
markdown (class).
commondoc-markdown/raw-html/file-type.lispcommondoc-markdown/raw-html (system).
emit-document (method).
emit-document (method).
html (reader method).
make-raw-html-block (function).
make-raw-inline-html (function).
raw-html (class).
raw-html-block (class).
raw-inline-html (class).
commondoc-markdown/utils/file-type.lispcommondoc-markdown/utils (system).
parse-tree-p (function).
parse-tree-to-text (function).
commondoc-markdown/emitter/file-type.lispcommondoc-markdown/emitter (system).
*emit-section-anchors* (special variable).
*generate-short-link-references* (special variable).
*min-link-hash-length* (special variable).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
emit-document (method).
*hash->link* (special variable).
*header-level* (special variable).
*inhibit-paragraph-breaks* (special variable).
*link->hash* (special variable).
emit (method).
get-line-backticks-count (function).
get-num-required-backticks (function).
hash-link (function).
make-fence (function).
write-header (function).
write-header-prefix (function).
Packages are listed by definition order.
commondoc-markdown/emittercommondoc-markdown/utilscommondoc-markdowncommondoc-markdown/raw-htmlcommondoc-markdown/formatcommondoc-markdown/addonscommondoc-markdown/emittercommon-lisp.
*emit-section-anchors* (special variable).
*generate-short-link-references* (special variable).
*min-link-hash-length* (special variable).
*hash->link* (special variable).
*header-level* (special variable).
*inhibit-paragraph-breaks* (special variable).
*link->hash* (special variable).
get-line-backticks-count (function).
get-num-required-backticks (function).
hash-link (function).
make-fence (function).
write-header (function).
write-header-prefix (function).
commondoc-markdown/utilscommon-lisp.
parse-tree-p (function).
parse-tree-to-text (function).
commondoc-markdowncommondoc-markdown/core
common-lisp.
make-markdown-link (function).
markdown-link (class).
markdown-link-definition (generic reader).
(setf markdown-link-definition) (generic writer).
*create-node-recursive-call* (special variable).
*link-references* (special variable).
*sections-stack* (special variable).
call-with-collected-references (function).
create-node (function).
find-url (function).
go-deeper (macro).
line-break (class).
make-inline-nodes (function).
parse-markdown (function).
with-collected-references (macro).
commondoc-markdown/raw-htmlcommon-lisp.
html (generic reader).
make-raw-html-block (function).
make-raw-inline-html (function).
raw-html (class).
raw-html-block (class).
raw-inline-html (class).
commondoc-markdown/addonscommon-lisp.
*strikethrough* (special variable).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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‘.
markdown-link)) ¶markdown-link)) ¶A definition slug for the linked document.
markdown) (node line-break) stream) ¶common-doc.format.
markdown) (node raw-inline-html) stream) ¶common-doc.format.
markdown) (node raw-html-block) stream) ¶common-doc.format.
markdown) (node block-quote) stream) ¶common-doc.format.
markdown) (node ordered-list) stream) ¶common-doc.format.
markdown) (node unordered-list) stream) ¶common-doc.format.
markdown) (node code-block) stream) ¶common-doc.format.
markdown) (node paragraph) stream) ¶common-doc.format.
markdown) (node content-node) stream) ¶common-doc.format.
markdown) (node document-link) stream) ¶common-doc.format.
markdown) (node web-link) stream) ¶common-doc.format.
markdown) (node document-node) stream) ¶common-doc.format.
markdown) (node text-node) stream) ¶common-doc.format.
markdown) (node document-node) stream) ¶common-doc.format.
markdown) (node document) stream) ¶common-doc.format.
markdown-link) (link-b markdown-link)) ¶common-doc.ops.
The Markdown format.
document-format.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
emit-document.
parse-document.
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.
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
line-break)) ¶common-html.emitter.
raw-inline-html)) ¶common-html.emitter.
raw-html-block)) ¶common-html.emitter.
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.
| Jump to: | (
C E F G H M N P W |
|---|
| Jump to: | (
C E F G H M N P W |
|---|
| 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 |
|---|