The 3bmd Reference Manual

Table of Contents

The 3bmd Reference Manual

This is the 3bmd Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:35:38 2020 GMT+0.

1 Introduction

Common Lisp Markdown -> html converter, using esrap for parsing, and grammar based on peg-markdown.

Currently a bit slow and uses lots of RAM for large documents (particularly when using the top-level doc parser instead of reading documents as a sequence of blocks), but seems to handle the tests from peg-markdown reasonably well.

todo:

• clean up API
• figure out how to automate testing (closure-html + tree-equal? need some way to normalize whitespace though), and add tests
• optimize grammar
• optimize esrap

Extensions:

• If 3bmd:*smart-quotes* is non-NIL while parsing, some extra patterns will be recognized and converted as follows (outside code blocks):

  • 'single quoted strings' -> ‘ ... ’ like ‘single quoted string’ (with slightly ugly heuristics to avoid contractions)
  • other single quotes ' -> ' '
  • "double quoted strings" -> “ ... ”, like “double quoted string”
  • ellipsis ... or . . . -> …, …
  • en dash -- -> –, –
  • em dash --- -> —, —
  • left right arrow <-> -> ↔, ↔
  • left arrow <- -> ←, ←
  • right arrow -> -> →, →
  • left right double arrow <=> -> &hArr, ⇔
  • left double arrow <= -> ⇐, ⇐
  • right double arrow => -> ⇒, ⇒

• Loading 3bmd-ext-wiki-links.asd adds support for parsing simple [[]] style wiki links: If 3bmd-wiki:*wiki-links* is non-NIL while parsing, wiki links of the form [[foo]] or [[foo|...]] will be parsed, where ... is one or more optional args separated by | characters. By default, wiki links will just print the foo part as normal text. To integrate into an actual wiki, users should bind 3bmd-wiki:*wiki-processor* during printing, and define a method on 3bmd-wiki:process-wiki-link that specializes on the value of 3bmd-wiki:*wiki-processor* to create an HTML link from the foo and arguments. (API subject to change.)

• Loading 3bmd-ext-code-blocks.asd adds support for github style fenced code blocks, with colorize support: If 3bmd-code-blocks:*code-blocks* is non-NIL while parsing, in addition to normal indented verbatim blocks, ``` can be used to delimit blocks of code:

    ```
    This block doesn't specify a language for colorization
    ```
  

  or

    ```lisp
    ;;; this block will be colorized as Common Lisp
    (defun foo (bar)
      (list bar))
    ```
  

  Language names ignore case and whitespace, so Common Lisp and commonlisp are treated the same, see 3bmd:*colorize-name-map* for full list of supported language names, or add names to that to recognize a custom colorize coloring-type. If a language name is not specified after the opening ```, 3bmd-code-blocks:*code-blocks-default-colorize* can be set to one of the keywords naming a coloring-type recognized by colorize to specify a default, otherwise the block will not be colorized.

  Can optionally use Pygments instead of colorize by setting 3bmd-code-blocks:*renderer* to :pygments. Lexer and formatter options (-O) can be specified like ```c++|linenos=1.

  Some attempt has been made to avoid interpretation of the options by the shell when calling pygmentize, but you should probably audit the code and test the interaction with the implementation of uiop:run-program on your implementation of choice before using it on untrusted input. Pygments html formatter creates arbitrary files when passed -Ofull,cssfile=filename, so parameters with the substring cssfile are ignored (noclobber_cssfile=True is also set by default, but that only prevents overwriting, not creation). Users with untrusted input may want to audit that as well to make sure there are no other dangerous options or ways to get around the exact substring check.

  Can optionally use Chroma instead of colorize or Pygments by setting 3bmd-code-blocks:*renderer* to :chroma. Change the embedded theme of the :chroma code block via 3bmd-code-blocks:*chroma-style*. The various styles for Chroma can be viewed via chroma --list.

  If no highlighting is desired, in case of using a JavaScript highlighter, it is possible to specify :nohighlight as 3bmd-code-blocks:*renderer*. In this case the pre tags class attribute is rendered with the defined language. So:

  ```lisp
  (defun foo ())
  

  Is rendered as:

  <pre class="lisp"><code>...</code></pre>
  

  To change the format used for rendering the class attribute value you can set a different format to *code-blocks-pre-class-format* which defaults to ~a in order to render the language as parsed from the tripple ticks block. I.e.: setting the format (setf 3bmd-code-blocks:*code-blocks-pre-class-format* "brush: ~a;") will render:

  <pre class="brush: lisp;"><code>...</code></pre>    
  

• Loading 3bmd-ext-definition-lists.asd adds support for parsing PHP Markdown Extra style definition lists If 3bmd-definition-lists:*definition-lists* is non-NIL while parsing, the following definition list will be recognized (see http://michelf.ca/projects/php-markdown/extra/#def-list):

    Term
    : definition
  

• Loading 3bmd-ext-tables.asd adds support for parsing PHP Markdown Extra style tables If 3bmd-tables:*tables* is non-NIL while parsing, the following will be recognized as tables (see http://michelf.ca/projects/php-markdown/extra/#table):

    | Content Cell  | Content Cell  |
    | Content Cell  | Content Cell  |
  
    | First Header  | Second Header |
    | ------------- | ------------- |
    | Content Cell  | Content Cell  |
    | Content Cell  | Content Cell  |
  
    | Name | Description          |
    | ------------- | ----------- |
    | Help      | Display the help window.|
    | Close     | Closes a window     |
  
    | Left-Aligned  | Center Aligned  | Right Aligned |
    | :------------ |:---------------:| -----:|
    | col 3 is      | some wordy text | $1600 |
    | col 2 is      | centered        |   $12 |
    | zebra stripes | are neat        |    $1 |
  

  The following simplified table style is not supported, because it is ambiguous, especially, without heading:

  First Header  | Second Header
  ------------- | -------------
  Content Cell  | Content Cell
  Content Cell  | Content Cell
  

• Loading 3bmd-youtube.asd adds support for. If 3bmd-youtube:*youtube-embeds* is non-NIL while parsing, the shorthand syntax !yt[video-id(|options)] can be be used. For example

    !yt[nbY-meOL57I]
    !yt[nbY-meOL57I|width=20,allowfullscreen]"
  

• Loading 3bmd-math.asd adds support for math markup with libraries like MathJax. If 3bmd-math:*math* is non-NIL while parsing, the shorthand syntax $$ latex markup $$ can be be used. For example:

    $$
    \frac{\partial E}{\partial y} = \frac{\partial }{\partial y} \frac{1}{n}\sum_{i=1}^{n} (y_i - a_i)^2
    $$
  

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 3bmd

Author

Bart Botta <00003b at gmail.com>

License

MIT

Description

markdown processor in CL using esrap parser.

Dependencies

• esrap
• split-sequence
• alexandria

Source

3bmd.asd (file)

Components

• package.lisp (file)
• parser.lisp (file)
• extensions.lisp (file)
• smart-quotes.lisp (file)
• printer.lisp (file)
• markdown-printer.lisp (file)
• plain-printer.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 3bmd.asd

Location

3bmd.asd

Systems

3bmd (system)

3.1.2 3bmd/package.lisp

Parent

3bmd (system)

Location

package.lisp

Packages

• 3bmd
• 3bmd-ext
• 3bmd-grammar

3.1.3 3bmd/parser.lisp

Dependency

package.lisp (file)

Parent

3bmd (system)

Location

parser.lisp

Exported Definitions

parse-doc (function)

Internal Definitions

• %block-rules% (special variable)
• %extended-escape-char-rules% (special variable)
• %extended-special-char-rules% (special variable)
• %inline-rules% (special variable)
• ascii-char-p (function)

3.1.4 3bmd/extensions.lisp

Dependency

parser.lisp (file)

Parent

3bmd (system)

Location

extensions.lisp

Exported Definitions

• define-extension-block (macro)
• define-extension-inline (macro)

Internal Definitions

• %make-definer (function)
• add-expression-to-list (function)

3.1.5 3bmd/smart-quotes.lisp

Dependency

extensions.lisp (file)

Parent

3bmd (system)

Location

smart-quotes.lisp

Exported Definitions

*smart-quotes* (special variable)

3.1.6 3bmd/printer.lisp

Dependency

smart-quotes.lisp (file)

Parent

3bmd (system)

Location

printer.lisp

Exported Definitions

• *allowed-id-chars* (special variable)
• *generate-header-ids* (special variable)
• expand-tabs (function)
• parse-and-print-to-stream (function)
• parse-string-and-print-to-stream (function)
• print-doc-to-stream (function)
• print-element (method)
• print-element (method)
• print-element (method)
• print-element (method)
• print-label-to-string (function)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)

Internal Definitions

• *always-title* (special variable)
• *in-code* (special variable)
• *padding* (special variable)
• *references* (special variable)
• define-smart-quote-entity (macro)
• encode-email (function)
• escape-pre-string (function)
• escape-string (function)
• extract-refs (function)
• html-content-id (function)
• lookup-reference (function)
• padded (macro)
• print-doc-to-stream-using-format (method)
• print-escaped (function)
• print-pre-escaped (function)

3.1.7 3bmd/markdown-printer.lisp

Dependency

printer.lisp (file)

Parent

3bmd (system)

Location

markdown-printer.lisp

Exported Definitions

• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)

Internal Definitions

• *md-block-seen-p* (special variable)
• *md-in-block* (special variable)
• *md-indent* (special variable)
• *md-list-item* (special variable)
• define-smart-quote-md-translation (macro)
• end-block (function)
• ensure-block (function)
• max-n-consecutive-backticks (function)
• max-n-consecutive-char (function)
• md-indent (function)
• print-doc-to-stream-using-format (method)
• print-md (function)
• print-md-element (method)
• print-md-element (method)
• print-md-element (method)
• print-md-escaped (function)
• remove-ending-newline (function)
• with-md-indent (macro)

3.1.8 3bmd/plain-printer.lisp

Dependency

markdown-printer.lisp (file)

Parent

3bmd (system)

Location

plain-printer.lisp

Internal Definitions

• *plain-text-pprint* (special variable)
• pprinter (macro)
• print-doc-to-stream-using-format (method)

4 Packages

Packages are listed by definition order.

4.1 3bmd

Source

package.lisp (file)

Use List

• 3bmd-ext
• 3bmd-grammar
• common-lisp

Exported Definitions

• *allowed-id-chars* (special variable)
• *generate-header-ids* (special variable)
• parse-and-print-to-stream (function)
• parse-string-and-print-to-stream (function)
• print-doc-to-stream (function)

Internal Definitions

• *always-title* (special variable)
• *in-code* (special variable)
• *md-block-seen-p* (special variable)
• *md-in-block* (special variable)
• *md-indent* (special variable)
• *md-list-item* (special variable)
• *padding* (special variable)
• *plain-text-pprint* (special variable)
• *references* (special variable)
• define-smart-quote-entity (macro)
• define-smart-quote-md-translation (macro)
• encode-email (function)
• end-block (function)
• ensure-block (function)
• escape-pre-string (function)
• escape-string (function)
• extract-refs (function)
• html-content-id (function)
• lookup-reference (function)
• max-n-consecutive-backticks (function)
• max-n-consecutive-char (function)
• md-indent (function)
• padded (macro)
• pprinter (macro)
• print-doc-to-stream-using-format (generic function)
• print-doc-to-stream-using-format (method)
• print-doc-to-stream-using-format (method)
• print-doc-to-stream-using-format (method)
• print-escaped (function)
• print-md (function)
• print-md-element (generic function)
• print-md-element (method)
• print-md-element (method)
• print-md-element (method)
• print-md-escaped (function)
• print-pre-escaped (function)
• remove-ending-newline (function)
• with-md-indent (macro)

4.2 3bmd-ext

Source

package.lisp (file)

Use List

• 3bmd-grammar
• common-lisp

Used By List

3bmd

Exported Definitions

• expand-tabs (function)
• print-element (generic function)
• print-element (method)
• print-element (method)
• print-element (method)
• print-element (method)
• print-label-to-string (function)
• print-md-tagged-element (generic function)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-md-tagged-element (method)
• print-tagged-element (generic function)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)
• print-tagged-element (method)

4.3 3bmd-grammar

Source

package.lisp (file)

Use List

• esrap
• common-lisp

Used By List

• 3bmd
• 3bmd-ext

Exported Definitions

• *smart-quotes* (special variable)
• define-extension-block (macro)
• define-extension-inline (macro)
• parse-doc (function)

Internal Definitions

• %block-rules% (special variable)
• %extended-escape-char-rules% (special variable)
• %extended-special-char-rules% (special variable)
• %inline-rules% (special variable)
• %make-definer (function)
• add-expression-to-list (function)
• ascii-char-p (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *allowed-id-chars*

A string of characters that are allowed to appear within an element ID string.

Package

3bmd

Source

printer.lisp (file)

Special Variable: *generate-header-ids*

Whether ID attributes should be generated for header elements.

Package

3bmd

Source

printer.lisp (file)

Special Variable: *smart-quotes*

Package

3bmd-grammar

Source

smart-quotes.lisp (file)

5.1.2 Macros

Macro: define-extension-block EXTENSION-FLAG NAME EXPRESSION &body OPTIONS

Package

3bmd-grammar

Source

extensions.lisp (file)

Macro: define-extension-inline EXTENSION-FLAG NAME EXPRESSION &body OPTIONS

Package

3bmd-grammar

Source

extensions.lisp (file)

5.1.3 Functions

Function: expand-tabs DOC &key ADD-NEWLINES

Package

3bmd-ext

Source

printer.lisp (file)

Function: parse-and-print-to-stream FILE STREAM &key FORMAT

Package

3bmd

Source

printer.lisp (file)

Function: parse-doc A

Package

3bmd-grammar

Source

parser.lisp (file)

Function: parse-string-and-print-to-stream STRING STREAM &key FORMAT

Package

3bmd

Source

printer.lisp (file)

Function: print-doc-to-stream DOC STREAM &key FORMAT

Package

3bmd

Source

printer.lisp (file)

Function: print-label-to-string LABEL

Package

3bmd-ext

Source

printer.lisp (file)

5.1.4 Generic functions

Generic Function: print-element ELEM STREAM

Package

3bmd-ext

Methods

Method: print-element (ELEM cons) STREAM

Source

printer.lisp (file)

Method: print-element (ELEM string) STREAM

Source

printer.lisp (file)

Method: print-element (ELEM (eql apostrophe)) STREAM

Source

printer.lisp (file)

Method: print-element (ELEM null) STREAM

Source

printer.lisp (file)

Generic Function: print-md-tagged-element TAG STREAM REST

Package

3bmd-ext

Methods

Method: print-md-tagged-element (TAG (eql reference)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql ellipsis)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql right-double-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql left-double-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql left-right-double-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql right-single-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql left-single-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql left-right-single-arrow)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql em-dash)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql en-dash)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql double-quoted)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql single-quoted)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql code)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql unescaped-string)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql verbatim)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql entity)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql raw-html)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql html)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql horizontal-rule)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql line-break)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql list-item)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql bullet-list)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql counted-list)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql image)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql reference-link)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql explicit-link)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql mailto)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql link)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql strong)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql emph)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql plain)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql block-quote)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql paragraph)) STREAM REST

Source

markdown-printer.lisp (file)

Method: print-md-tagged-element (TAG (eql heading)) STREAM REST

Source

markdown-printer.lisp (file)

Generic Function: print-tagged-element TAG STREAM REST

Package

3bmd-ext

Methods

Method: print-tagged-element (TAG (eql reference)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql ellipsis)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql right-double-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql left-double-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql left-right-double-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql right-single-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql left-single-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql left-right-single-arrow)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql en-dash)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql em-dash)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql double-quoted)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql single-quoted)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql code)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql verbatim)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql entity)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql raw-html)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql html)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql horizontal-rule)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql line-break)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql list-item)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql bullet-list)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql counted-list)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql image)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql reference-link)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql explicit-link)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql mailto)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql link)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql strong)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql emph)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql plain)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql block-quote)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql paragraph)) STREAM REST

Source

printer.lisp (file)

Method: print-tagged-element (TAG (eql heading)) STREAM REST

Source

printer.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: %block-rules%

internal hook for extending ’block’ grammar, don’t modify directly

Package

3bmd-grammar

Source

parser.lisp (file)

Special Variable: %extended-escape-char-rules%

Package

3bmd-grammar

Source

parser.lisp (file)

Special Variable: %extended-special-char-rules%

Package

3bmd-grammar

Source

parser.lisp (file)

Special Variable: %inline-rules%

internal hook for extending ’inline’ grammar, don’t modify directly

Package

3bmd-grammar

Source

parser.lisp (file)

Special Variable: *always-title*

Package

3bmd

Source

printer.lisp (file)

Special Variable: *in-code*

Package

3bmd

Source

printer.lisp (file)

Special Variable: *md-block-seen-p*

Package

3bmd

Source

markdown-printer.lisp (file)

Special Variable: *md-in-block*

Package

3bmd

Source

markdown-printer.lisp (file)

Special Variable: *md-indent*

Package

3bmd

Source

markdown-printer.lisp (file)

Special Variable: *md-list-item*

Package

3bmd

Source

markdown-printer.lisp (file)

Special Variable: *padding*

Package

3bmd

Source

printer.lisp (file)

Special Variable: *plain-text-pprint*

Package

3bmd

Source

plain-printer.lisp (file)

Special Variable: *references*

Package

3bmd

Source

printer.lisp (file)

5.2.2 Macros

Macro: define-smart-quote-entity NAME REPLACEMENT

Package

3bmd

Source

printer.lisp (file)

Macro: define-smart-quote-md-translation NAME REPLACEMENT

Package

3bmd

Source

markdown-printer.lisp (file)

Macro: padded (N S &optional NEXT) &body BODY

Package

3bmd

Source

printer.lisp (file)

Macro: pprinter TAG (STREAM-VAR OBJECT-VAR) &body BODY

Package

3bmd

Source

plain-printer.lisp (file)

Macro: with-md-indent (INDENT) &body BODY

Package

3bmd

Source

markdown-printer.lisp (file)

5.2.3 Functions

Function: %make-definer EXTENSION-FLAG NAME EXPRESSION OPTIONS VAR RULE EXP

Package

3bmd-grammar

Source

extensions.lisp (file)

Function: add-expression-to-list NEW LIST &key BEFORE AFTER TEST

Package

3bmd-grammar

Source

extensions.lisp (file)

Function: ascii-char-p C

Package

3bmd-grammar

Source

parser.lisp (file)

Function: encode-email TEXT

Package

3bmd

Source

printer.lisp (file)

Function: end-block STREAM

Package

3bmd

Source

markdown-printer.lisp (file)

Function: ensure-block STREAM

Package

3bmd

Source

markdown-printer.lisp (file)

Function: escape-pre-string STRING

Package

3bmd

Source

printer.lisp (file)

Function: escape-string STRING

Package

3bmd

Source

printer.lisp (file)

Function: extract-refs DOC

Package

3bmd

Source

printer.lisp (file)

Function: html-content-id HTML

Package

3bmd

Source

printer.lisp (file)

Function: lookup-reference REF

Package

3bmd

Source

printer.lisp (file)

Function: max-n-consecutive-backticks PARSE-TREE

Package

3bmd

Source

markdown-printer.lisp (file)

Function: max-n-consecutive-char CHAR STRING

Package

3bmd

Source

markdown-printer.lisp (file)

Function: md-indent STREAM

Package

3bmd

Source

markdown-printer.lisp (file)

Function: print-escaped STRING STREAM

Package

3bmd

Source

printer.lisp (file)

Function: print-md STRING STREAM

Package

3bmd

Source

markdown-printer.lisp (file)

Function: print-md-escaped STRING STREAM

Package

3bmd

Source

markdown-printer.lisp (file)

Function: print-pre-escaped STRING STREAM

Package

3bmd

Source

printer.lisp (file)

Function: remove-ending-newline STRING

Package

3bmd

Source

markdown-printer.lisp (file)

5.2.4 Generic functions

Generic Function: print-doc-to-stream-using-format DOC STREAM FORMAT

Package

3bmd

Methods

Method: print-doc-to-stream-using-format DOC STREAM (FORMAT (eql plain))

Source

plain-printer.lisp (file)

Method: print-doc-to-stream-using-format DOC STREAM (FORMAT (eql markdown))

Source

markdown-printer.lisp (file)

Method: print-doc-to-stream-using-format DOC STREAM (FORMAT (eql html))

Source

printer.lisp (file)

Generic Function: print-md-element ELEM STREAM

Package

3bmd

Methods

Method: print-md-element (ELEM cons) STREAM

Source

markdown-printer.lisp (file)

Method: print-md-element (ELEM string) STREAM

Source

markdown-printer.lisp (file)

Method: print-md-element (ELEM (eql apostrophe)) STREAM

Source

markdown-printer.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types