Created
January 1, 2018 18:29
-
-
Save ccorn/b19643d3e0b4837d4d558211dd726409 to your computer and use it in GitHub Desktop.
Changes to kramdown HTML doc with [PR 482](https://github.com/gettalong/kramdown/pull/482)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| diff -ru htmldoc-old/converter/html.html htmldoc-new/converter/html.html | |
| --- htmldoc-old/converter/html.html 2018-01-01 14:28:41.000000000 +0100 | |
| +++ htmldoc-new/converter/html.html 2018-01-01 14:27:58.000000000 +0100 | |
| @@ -327,7 +327,8 @@ | |
| <dl> | |
| <dt><code id="option-auto-ids">auto_ids</code></dt> | |
| - <dd>Use automatic header ID generation | |
| + <dd> | |
| + <p>Use automatic header ID generation</p> | |
| <p>If this option is <code>true</code>, ID values for all headers are automatically | |
| generated if no ID is explicitly specified.</p> | |
| @@ -336,7 +337,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-auto-id-prefix">auto_id_prefix</code></dt> | |
| - <dd>Prefix used for automatically generated header IDs | |
| + <dd> | |
| + <p>Prefix used for automatically generated header IDs</p> | |
| <p>This option can be used to set a prefix for the automatically generated | |
| header IDs so that there is no conflict when rendering multiple kramdown | |
| @@ -347,7 +349,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-auto-id-stripping">auto_id_stripping</code></dt> | |
| - <dd>Strip all formatting from header text for automatic ID generation | |
| + <dd> | |
| + <p>Strip all formatting from header text for automatic ID generation</p> | |
| <p>If this option is <code>true</code>, only the text elements of a header are used | |
| for generating the ID later (in contrast to just using the raw header | |
| @@ -360,7 +363,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-transliterated-header-ids">transliterated_header_ids</code></dt> | |
| - <dd>Transliterate the header text before generating the ID | |
| + <dd> | |
| + <p>Transliterate the header text before generating the ID</p> | |
| <p>Only ASCII characters are used in headers IDs. This is not good for | |
| languages with many non-ASCII characters. By enabling this option | |
| @@ -373,8 +377,9 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-template">template</code></dt> | |
| - <dd>The name of an ERB template file that should be used to wrap the output | |
| -or the ERB template itself. | |
| + <dd> | |
| + <p>The name of an ERB template file that should be used to wrap the output | |
| +or the ERB template itself.</p> | |
| <p>This is used to wrap the output in an environment so that the output can | |
| be used as a stand-alone document. For example, an HTML template would | |
| @@ -397,7 +402,8 @@ | |
| Used by: all converters</p> | |
| </dd> | |
| <dt><code id="option-footnote-nr">footnote_nr</code></dt> | |
| - <dd>The number of the first footnote | |
| + <dd> | |
| + <p>The number of the first footnote</p> | |
| <p>This option can be used to specify the number that is used for the first | |
| footnote.</p> | |
| @@ -406,7 +412,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-entity-output">entity_output</code></dt> | |
| - <dd>Defines how entities are output | |
| + <dd> | |
| + <p>Defines how entities are output</p> | |
| <p>The possible values are :as_input (entities are output in the same | |
| form as found in the input), :numeric (entities are output in numeric | |
| @@ -418,7 +425,8 @@ | |
| Used by: HTML converter, kramdown converter</p> | |
| </dd> | |
| <dt><code id="option-smart-quotes">smart_quotes</code></dt> | |
| - <dd>Defines the HTML entity names or code points for smart quote output | |
| + <dd> | |
| + <p>Defines the HTML entity names or code points for smart quote output</p> | |
| <p>The entities identified by entity name or code point that should be | |
| used for, in order, a left single quote, a right single quote, a left | |
| @@ -429,7 +437,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-toc-levels">toc_levels</code></dt> | |
| - <dd>Defines the levels that are used for the table of contents | |
| + <dd> | |
| + <p>Defines the levels that are used for the table of contents</p> | |
| <p>The individual levels can be specified by separating them with commas | |
| (e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the | |
| @@ -439,7 +448,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-enable-coderay">enable_coderay</code></dt> | |
| - <dd>Use coderay for syntax highlighting | |
| + <dd> | |
| + <p>Use coderay for syntax highlighting</p> | |
| <p>If this option is <code>true</code>, coderay is used by the HTML converter for | |
| syntax highlighting the content of code spans and code blocks.</p> | |
| @@ -448,7 +458,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-wrap">coderay_wrap</code></dt> | |
| - <dd>Defines how the highlighted code should be wrapped | |
| + <dd> | |
| + <p>Defines how the highlighted code should be wrapped</p> | |
| <p>The possible values are :span, :div or nil.</p> | |
| @@ -456,7 +467,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-line-numbers">coderay_line_numbers</code></dt> | |
| - <dd>Defines how and if line numbers should be shown | |
| + <dd> | |
| + <p>Defines how and if line numbers should be shown</p> | |
| <p>The possible values are :table, :inline or nil. If this option is | |
| nil, no line numbers are shown.</p> | |
| @@ -465,7 +477,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-line-number-start">coderay_line_number_start</code></dt> | |
| - <dd>The start value for the line numbers | |
| + <dd> | |
| + <p>The start value for the line numbers</p> | |
| <p>Default: 1<br /> | |
| Used by: HTML converter</p> | |
| @@ -475,7 +488,8 @@ | |
| <br /> | |
| Used by: HTML converter</dd> | |
| <dt><code id="option-coderay-bold-every">coderay_bold_every</code></dt> | |
| - <dd>Defines how often a line number should be made bold | |
| + <dd> | |
| + <p>Defines how often a line number should be made bold</p> | |
| <p>Can either be an integer or false (to turn off bold line numbers | |
| completely).</p> | |
| @@ -484,7 +498,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-css">coderay_css</code></dt> | |
| - <dd>Defines how the highlighted code gets styled | |
| + <dd> | |
| + <p>Defines how the highlighted code gets styled</p> | |
| <p>Possible values are :class (CSS classes are applied to the code | |
| elements, one must supply the needed CSS file) or :style (default CSS | |
| @@ -494,7 +509,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-default-lang">coderay_default_lang</code></dt> | |
| - <dd>Sets the default language for highlighting code blocks | |
| + <dd> | |
| + <p>Sets the default language for highlighting code blocks</p> | |
| <p>If no language is set for a code block, the default language is used | |
| instead. The value has to be one of the languages supported by coderay | |
| @@ -504,7 +520,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter">syntax_highlighter</code></dt> | |
| - <dd>Set the syntax highlighter | |
| + <dd> | |
| + <p>Set the syntax highlighter</p> | |
| <p>Specifies the syntax highlighter that should be used for highlighting | |
| code blocks and spans. If this option is set to +nil+, no syntax | |
| @@ -517,7 +534,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter-opts">syntax_highlighter_opts</code></dt> | |
| - <dd>Set the syntax highlighter options | |
| + <dd> | |
| + <p>Set the syntax highlighter options</p> | |
| <p>Specifies options for the syntax highlighter set via the | |
| syntax_highlighter configuration option.</p> | |
| @@ -529,7 +547,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-math-engine">math_engine</code></dt> | |
| - <dd>Set the math engine | |
| + <dd> | |
| + <p>Set the math engine</p> | |
| <p>Specifies the math engine that should be used for converting math | |
| blocks/spans. If this option is set to +nil+, no math engine is used and | |
| @@ -542,7 +561,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-math-engine-opts">math_engine_opts</code></dt> | |
| - <dd>Set the math engine options | |
| + <dd> | |
| + <p>Set the math engine options</p> | |
| <p>Specifies options for the math engine set via the math_engine | |
| configuration option.</p> | |
| @@ -554,7 +574,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-footnote-backlink">footnote_backlink</code></dt> | |
| - <dd>Defines the text that should be used for the footnote backlinks | |
| + <dd> | |
| + <p>Defines the text that should be used for the footnote backlinks</p> | |
| <p>The footnote backlink is just text, so any special HTML characters will | |
| be escaped.</p> | |
| @@ -566,7 +587,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-footnote-backlink-inline">footnote_backlink_inline</code></dt> | |
| - <dd>Specifies whether the footnote backlink should always be inline | |
| + <dd> | |
| + <p>Specifies whether the footnote backlink should always be inline</p> | |
| <p>With the default of false the footnote backlink is placed at the end of | |
| the last paragraph if there is one, or an extra paragraph with only the | |
| @@ -581,7 +603,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-typographic-symbols">typographic_symbols</code></dt> | |
| - <dd>Defines a mapping from typographical symbol to output characters | |
| + <dd> | |
| + <p>Defines a mapping from typographical symbol to output characters</p> | |
| <p>Typographical symbols are normally output using their equivalent Unicode | |
| codepoint. However, sometimes one wants to change the output, mostly to | |
| diff -ru htmldoc-old/converter/kramdown.html htmldoc-new/converter/kramdown.html | |
| --- htmldoc-old/converter/kramdown.html 2018-01-01 14:28:41.000000000 +0100 | |
| +++ htmldoc-new/converter/kramdown.html 2018-01-01 14:27:58.000000000 +0100 | |
| @@ -121,7 +121,8 @@ | |
| <dl> | |
| <dt><code id="option-entity-output">entity_output</code></dt> | |
| - <dd>Defines how entities are output | |
| + <dd> | |
| + <p>Defines how entities are output</p> | |
| <p>The possible values are :as_input (entities are output in the same | |
| form as found in the input), :numeric (entities are output in numeric | |
| @@ -133,8 +134,9 @@ | |
| Used by: HTML converter, kramdown converter</p> | |
| </dd> | |
| <dt><code id="option-template">template</code></dt> | |
| - <dd>The name of an ERB template file that should be used to wrap the output | |
| -or the ERB template itself. | |
| + <dd> | |
| + <p>The name of an ERB template file that should be used to wrap the output | |
| +or the ERB template itself.</p> | |
| <p>This is used to wrap the output in an environment so that the output can | |
| be used as a stand-alone document. For example, an HTML template would | |
| diff -ru htmldoc-old/converter/latex.html htmldoc-new/converter/latex.html | |
| --- htmldoc-old/converter/latex.html 2018-01-01 14:28:41.000000000 +0100 | |
| +++ htmldoc-new/converter/latex.html 2018-01-01 14:27:58.000000000 +0100 | |
| @@ -206,7 +206,8 @@ | |
| <dl> | |
| <dt><code id="option-auto-ids">auto_ids</code></dt> | |
| - <dd>Use automatic header ID generation | |
| + <dd> | |
| + <p>Use automatic header ID generation</p> | |
| <p>If this option is <code>true</code>, ID values for all headers are automatically | |
| generated if no ID is explicitly specified.</p> | |
| @@ -215,7 +216,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-auto-id-prefix">auto_id_prefix</code></dt> | |
| - <dd>Prefix used for automatically generated header IDs | |
| + <dd> | |
| + <p>Prefix used for automatically generated header IDs</p> | |
| <p>This option can be used to set a prefix for the automatically generated | |
| header IDs so that there is no conflict when rendering multiple kramdown | |
| @@ -226,7 +228,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-auto-id-stripping">auto_id_stripping</code></dt> | |
| - <dd>Strip all formatting from header text for automatic ID generation | |
| + <dd> | |
| + <p>Strip all formatting from header text for automatic ID generation</p> | |
| <p>If this option is <code>true</code>, only the text elements of a header are used | |
| for generating the ID later (in contrast to just using the raw header | |
| @@ -239,7 +242,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-transliterated-header-ids">transliterated_header_ids</code></dt> | |
| - <dd>Transliterate the header text before generating the ID | |
| + <dd> | |
| + <p>Transliterate the header text before generating the ID</p> | |
| <p>Only ASCII characters are used in headers IDs. This is not good for | |
| languages with many non-ASCII characters. By enabling this option | |
| @@ -252,7 +256,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-toc-levels">toc_levels</code></dt> | |
| - <dd>Defines the levels that are used for the table of contents | |
| + <dd> | |
| + <p>Defines the levels that are used for the table of contents</p> | |
| <p>The individual levels can be specified by separating them with commas | |
| (e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the | |
| @@ -262,7 +267,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-latex-headers">latex_headers</code></dt> | |
| - <dd>Defines the LaTeX commands for different header levels | |
| + <dd> | |
| + <p>Defines the LaTeX commands for different header levels</p> | |
| <p>The commands for the header levels one to six can be specified by | |
| separating them with commas.</p> | |
| @@ -271,7 +277,8 @@ | |
| Used by: Latex converter</p> | |
| </dd> | |
| <dt><code id="option-smart-quotes">smart_quotes</code></dt> | |
| - <dd>Defines the HTML entity names or code points for smart quote output | |
| + <dd> | |
| + <p>Defines the HTML entity names or code points for smart quote output</p> | |
| <p>The entities identified by entity name or code point that should be | |
| used for, in order, a left single quote, a right single quote, a left | |
| @@ -282,8 +289,9 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-template">template</code></dt> | |
| - <dd>The name of an ERB template file that should be used to wrap the output | |
| -or the ERB template itself. | |
| + <dd> | |
| + <p>The name of an ERB template file that should be used to wrap the output | |
| +or the ERB template itself.</p> | |
| <p>This is used to wrap the output in an environment so that the output can | |
| be used as a stand-alone document. For example, an HTML template would | |
| @@ -306,7 +314,8 @@ | |
| Used by: all converters</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter">syntax_highlighter</code></dt> | |
| - <dd>Set the syntax highlighter | |
| + <dd> | |
| + <p>Set the syntax highlighter</p> | |
| <p>Specifies the syntax highlighter that should be used for highlighting | |
| code blocks and spans. If this option is set to +nil+, no syntax | |
| @@ -319,7 +328,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter-opts">syntax_highlighter_opts</code></dt> | |
| - <dd>Set the syntax highlighter options | |
| + <dd> | |
| + <p>Set the syntax highlighter options</p> | |
| <p>Specifies options for the syntax highlighter set via the | |
| syntax_highlighter configuration option.</p> | |
| @@ -331,7 +341,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-typographic-symbols">typographic_symbols</code></dt> | |
| - <dd>Defines a mapping from typographical symbol to output characters | |
| + <dd> | |
| + <p>Defines a mapping from typographical symbol to output characters</p> | |
| <p>Typographical symbols are normally output using their equivalent Unicode | |
| codepoint. However, sometimes one wants to change the output, mostly to | |
| diff -ru htmldoc-old/converter/remove_html_tags.html htmldoc-new/converter/remove_html_tags.html | |
| --- htmldoc-old/converter/remove_html_tags.html 2018-01-01 14:28:41.000000000 +0100 | |
| +++ htmldoc-new/converter/remove_html_tags.html 2018-01-01 14:27:58.000000000 +0100 | |
| @@ -126,7 +126,8 @@ | |
| <dl> | |
| <dt><code id="option-remove-block-html-tags">remove_block_html_tags</code></dt> | |
| - <dd>Remove block HTML tags | |
| + <dd> | |
| + <p>Remove block HTML tags</p> | |
| <p>If this option is <code>true</code>, the RemoveHtmlTags converter removes | |
| block HTML tags.</p> | |
| @@ -135,7 +136,8 @@ | |
| Used by: RemoveHtmlTags converter</p> | |
| </dd> | |
| <dt><code id="option-remove-span-html-tags">remove_span_html_tags</code></dt> | |
| - <dd>Remove span HTML tags | |
| + <dd> | |
| + <p>Remove span HTML tags</p> | |
| <p>If this option is <code>true</code>, the RemoveHtmlTags converter removes | |
| span HTML tags.</p> | |
| diff -ru htmldoc-old/math_engine/mathjax.html htmldoc-new/math_engine/mathjax.html | |
| --- htmldoc-old/math_engine/mathjax.html 2018-01-01 14:28:42.000000000 +0100 | |
| +++ htmldoc-new/math_engine/mathjax.html 2018-01-01 14:27:56.000000000 +0100 | |
| @@ -113,9 +113,10 @@ | |
| preview with the LaTeX code itself is shown. If it is set to any value other than <code>false</code> or | |
| <code>true</code>, that value is shown as the preview.</dd> | |
| <dt>preview_as_code</dt> | |
| - <dd>When <code>true</code>, wraps the LaTeX code in <code>code</code> / <code>pre > code</code> tags instead of <code>span</code> / <code>div</code> tags, | |
| + <dd> | |
| + <p>When <code>true</code>, wraps the LaTeX code in <code>code</code> / <code>pre > code</code> tags instead of <code>span</code> / <code>div</code> tags, | |
| mirroring the structure of inline code / code blocks. This ensures the content is styled like | |
| -regular code and improves legibility in RSS readers, text browsers, etc. | |
| +regular code and improves legibility in RSS readers, text browsers, etc.</p> | |
| <p>To prevent styling issues after MathJax has loaded, consider adding | |
| <code>.MathJax_Preview:empty { display:none }</code> to your CSS.</p> | |
| diff -ru htmldoc-old/math_engine/sskatex.html htmldoc-new/math_engine/sskatex.html | |
| --- htmldoc-old/math_engine/sskatex.html 2018-01-01 14:28:42.000000000 +0100 | |
| +++ htmldoc-new/math_engine/sskatex.html 2018-01-01 14:27:59.000000000 +0100 | |
| @@ -111,10 +111,11 @@ | |
| you want parse errors highlighted in the HTML output rather than raised as exceptions when | |
| compiling. Note that <code>displayMode</code> is computed dynamically and should not be specified here.</dd> | |
| <dt>js_run</dt> | |
| - <dd>An identifier for the Javascript engine to use. Recognized identifiers include: <code>RubyRacer</code>, | |
| + <dd> | |
| + <p>An identifier for the Javascript engine to use. Recognized identifiers include: <code>RubyRacer</code>, | |
| <code>RubyRhino</code>, <code>Duktape</code>, <code>MiniRacer</code>, <code>Node</code>, <code>JavaScriptCore</code>, <code>Spidermonkey</code>, <code>JScript</code>, <code>V8</code>, | |
| and <code>Disabled</code>; that last one would raise an error on first use. Which engines are actually | |
| -available depends on your installation. | |
| +available depends on your installation.</p> | |
| <p>If <strong>js_run</strong> is not defined, the contents of the environment variable <code>EXECJS_RUNTIME</code> will be | |
| considered instead; and if that is not defined, an automatic choice will be made. For more | |
| @@ -125,8 +126,9 @@ | |
| data directory of the <code>sskatex</code> gem. There is no need to change that setting unless you want to | |
| experiment with Javascript details.</dd> | |
| <dt>js_libs</dt> | |
| - <dd>A list of UTF-8-encoded Javascript helper files to load. Relative paths are interpreted relative | |
| -to <strong>js_dir</strong>. The default setting is | |
| + <dd> | |
| + <p>A list of UTF-8-encoded Javascript helper files to load. Relative paths are interpreted relative | |
| +to <strong>js_dir</strong>. The default setting is</p> | |
| <div class="language-yaml highlighter-coderay"><div class="CodeRay"> | |
| <div class="code"><pre><span style="color:#606">js_libs</span>: | |
| diff -ru htmldoc-old/options.html htmldoc-new/options.html | |
| --- htmldoc-old/options.html 2018-01-01 14:28:44.000000000 +0100 | |
| +++ htmldoc-new/options.html 2018-01-01 14:27:57.000000000 +0100 | |
| @@ -109,7 +109,8 @@ | |
| <dl> | |
| <dt>On the command line</dt> | |
| - <dd>The <code>kramdown</code> binary allows setting any option by using command line switches. | |
| + <dd> | |
| + <p>The <code>kramdown</code> binary allows setting any option by using command line switches.</p> | |
| <p>For example, the following command will disable automatic header ID generation and defines the | |
| first footnote number as 5:</p> | |
| @@ -121,7 +122,8 @@ | |
| of the binary as well as the man-page show all available options.</p> | |
| </dd> | |
| <dt>Within a kramdown document</dt> | |
| - <dd>By using the special extension syntax, it is possible to set options within a document. | |
| + <dd> | |
| + <p>By using the special extension syntax, it is possible to set options within a document.</p> | |
| <p>Using the above example, the options would be set like this within a document:</p> | |
| @@ -150,7 +152,8 @@ | |
| <dl> | |
| <dt><code id="option-auto-id-prefix">auto_id_prefix</code></dt> | |
| - <dd>Prefix used for automatically generated header IDs | |
| + <dd> | |
| + <p>Prefix used for automatically generated header IDs</p> | |
| <p>This option can be used to set a prefix for the automatically generated | |
| header IDs so that there is no conflict when rendering multiple kramdown | |
| @@ -161,7 +164,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-auto-id-stripping">auto_id_stripping</code></dt> | |
| - <dd>Strip all formatting from header text for automatic ID generation | |
| + <dd> | |
| + <p>Strip all formatting from header text for automatic ID generation</p> | |
| <p>If this option is <code>true</code>, only the text elements of a header are used | |
| for generating the ID later (in contrast to just using the raw header | |
| @@ -174,7 +178,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-auto-ids">auto_ids</code></dt> | |
| - <dd>Use automatic header ID generation | |
| + <dd> | |
| + <p>Use automatic header ID generation</p> | |
| <p>If this option is <code>true</code>, ID values for all headers are automatically | |
| generated if no ID is explicitly specified.</p> | |
| @@ -183,7 +188,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-bold-every">coderay_bold_every</code></dt> | |
| - <dd>Defines how often a line number should be made bold | |
| + <dd> | |
| + <p>Defines how often a line number should be made bold</p> | |
| <p>Can either be an integer or false (to turn off bold line numbers | |
| completely).</p> | |
| @@ -192,7 +198,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-css">coderay_css</code></dt> | |
| - <dd>Defines how the highlighted code gets styled | |
| + <dd> | |
| + <p>Defines how the highlighted code gets styled</p> | |
| <p>Possible values are :class (CSS classes are applied to the code | |
| elements, one must supply the needed CSS file) or :style (default CSS | |
| @@ -202,7 +209,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-default-lang">coderay_default_lang</code></dt> | |
| - <dd>Sets the default language for highlighting code blocks | |
| + <dd> | |
| + <p>Sets the default language for highlighting code blocks</p> | |
| <p>If no language is set for a code block, the default language is used | |
| instead. The value has to be one of the languages supported by coderay | |
| @@ -212,13 +220,15 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-line-number-start">coderay_line_number_start</code></dt> | |
| - <dd>The start value for the line numbers | |
| + <dd> | |
| + <p>The start value for the line numbers</p> | |
| <p>Default: 1<br /> | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-coderay-line-numbers">coderay_line_numbers</code></dt> | |
| - <dd>Defines how and if line numbers should be shown | |
| + <dd> | |
| + <p>Defines how and if line numbers should be shown</p> | |
| <p>The possible values are :table, :inline or nil. If this option is | |
| nil, no line numbers are shown.</p> | |
| @@ -231,7 +241,8 @@ | |
| <br /> | |
| Used by: HTML converter</dd> | |
| <dt><code id="option-coderay-wrap">coderay_wrap</code></dt> | |
| - <dd>Defines how the highlighted code should be wrapped | |
| + <dd> | |
| + <p>Defines how the highlighted code should be wrapped</p> | |
| <p>The possible values are :span, :div or nil.</p> | |
| @@ -239,7 +250,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-enable-coderay">enable_coderay</code></dt> | |
| - <dd>Use coderay for syntax highlighting | |
| + <dd> | |
| + <p>Use coderay for syntax highlighting</p> | |
| <p>If this option is <code>true</code>, coderay is used by the HTML converter for | |
| syntax highlighting the content of code spans and code blocks.</p> | |
| @@ -248,7 +260,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-entity-output">entity_output</code></dt> | |
| - <dd>Defines how entities are output | |
| + <dd> | |
| + <p>Defines how entities are output</p> | |
| <p>The possible values are :as_input (entities are output in the same | |
| form as found in the input), :numeric (entities are output in numeric | |
| @@ -260,7 +273,8 @@ | |
| Used by: HTML converter, kramdown converter</p> | |
| </dd> | |
| <dt><code id="option-footnote-backlink">footnote_backlink</code></dt> | |
| - <dd>Defines the text that should be used for the footnote backlinks | |
| + <dd> | |
| + <p>Defines the text that should be used for the footnote backlinks</p> | |
| <p>The footnote backlink is just text, so any special HTML characters will | |
| be escaped.</p> | |
| @@ -272,7 +286,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-footnote-backlink-inline">footnote_backlink_inline</code></dt> | |
| - <dd>Specifies whether the footnote backlink should always be inline | |
| + <dd> | |
| + <p>Specifies whether the footnote backlink should always be inline</p> | |
| <p>With the default of false the footnote backlink is placed at the end of | |
| the last paragraph if there is one, or an extra paragraph with only the | |
| @@ -287,7 +302,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-footnote-nr">footnote_nr</code></dt> | |
| - <dd>The number of the first footnote | |
| + <dd> | |
| + <p>The number of the first footnote</p> | |
| <p>This option can be used to specify the number that is used for the first | |
| footnote.</p> | |
| @@ -296,7 +312,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-gfm-quirks">gfm_quirks</code></dt> | |
| - <dd>Enables a set of GFM specific quirks | |
| + <dd> | |
| + <p>Enables a set of GFM specific quirks</p> | |
| <p>The way how GFM is transformed on Github often differs from the way | |
| kramdown does things. Many of these differences are negligible but | |
| @@ -332,7 +349,8 @@ | |
| Used by: GFM parser</p> | |
| </dd> | |
| <dt><code id="option-hard-wrap">hard_wrap</code></dt> | |
| - <dd>Interprets line breaks literally | |
| + <dd> | |
| + <p>Interprets line breaks literally</p> | |
| <p>Insert HTML <code><br /></code> tags inside paragraphs where the original Markdown | |
| document had newlines (by default, Markdown ignores these newlines).</p> | |
| @@ -341,7 +359,8 @@ | |
| Used by: GFM parser</p> | |
| </dd> | |
| <dt><code id="option-header-offset">header_offset</code></dt> | |
| - <dd>Sets the output offset for headers | |
| + <dd> | |
| + <p>Sets the output offset for headers</p> | |
| <p>If this option is c (may also be negative) then a header with level n | |
| will be output as a header with level c+n. If c+n is lower than 1, | |
| @@ -351,7 +370,8 @@ | |
| Used by: HTML converter, Kramdown converter, Latex converter</p> | |
| </dd> | |
| <dt><code id="option-html-to-native">html_to_native</code></dt> | |
| - <dd>Convert HTML elements to native elements | |
| + <dd> | |
| + <p>Convert HTML elements to native elements</p> | |
| <p>If this option is <code>true</code>, the parser converts HTML elements to native | |
| elements. For example, when parsing <code><em>hallo</em></code> the emphasis tag | |
| @@ -365,7 +385,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-latex-headers">latex_headers</code></dt> | |
| - <dd>Defines the LaTeX commands for different header levels | |
| + <dd> | |
| + <p>Defines the LaTeX commands for different header levels</p> | |
| <p>The commands for the header levels one to six can be specified by | |
| separating them with commas.</p> | |
| @@ -374,13 +395,15 @@ | |
| Used by: Latex converter</p> | |
| </dd> | |
| <dt><code id="option-line-width">line_width</code></dt> | |
| - <dd>Defines the line width to be used when outputting a document | |
| + <dd> | |
| + <p>Defines the line width to be used when outputting a document</p> | |
| <p>Default: 72<br /> | |
| Used by: kramdown converter</p> | |
| </dd> | |
| <dt><code id="option-link-defs">link_defs</code></dt> | |
| - <dd>Pre-defines link definitions | |
| + <dd> | |
| + <p>Pre-defines link definitions</p> | |
| <p>This option can be used to pre-define link definitions. The value needs | |
| to be a Hash where the keys are the link identifiers and the values are | |
| @@ -393,7 +416,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-math-engine">math_engine</code></dt> | |
| - <dd>Set the math engine | |
| + <dd> | |
| + <p>Set the math engine</p> | |
| <p>Specifies the math engine that should be used for converting math | |
| blocks/spans. If this option is set to +nil+, no math engine is used and | |
| @@ -406,7 +430,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-math-engine-opts">math_engine_opts</code></dt> | |
| - <dd>Set the math engine options | |
| + <dd> | |
| + <p>Set the math engine options</p> | |
| <p>Specifies options for the math engine set via the math_engine | |
| configuration option.</p> | |
| @@ -418,7 +443,8 @@ | |
| Used by: HTML converter</p> | |
| </dd> | |
| <dt><code id="option-parse-block-html">parse_block_html</code></dt> | |
| - <dd>Process kramdown syntax in block HTML tags | |
| + <dd> | |
| + <p>Process kramdown syntax in block HTML tags</p> | |
| <p>If this option is <code>true</code>, the kramdown parser processes the content of | |
| block HTML tags as text containing block-level elements. Since this is | |
| @@ -429,7 +455,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-parse-span-html">parse_span_html</code></dt> | |
| - <dd>Process kramdown syntax in span HTML tags | |
| + <dd> | |
| + <p>Process kramdown syntax in span HTML tags</p> | |
| <p>If this option is <code>true</code>, the kramdown parser processes the content of | |
| span HTML tags as text containing span-level elements.</p> | |
| @@ -438,7 +465,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-remove-block-html-tags">remove_block_html_tags</code></dt> | |
| - <dd>Remove block HTML tags | |
| + <dd> | |
| + <p>Remove block HTML tags</p> | |
| <p>If this option is <code>true</code>, the RemoveHtmlTags converter removes | |
| block HTML tags.</p> | |
| @@ -447,7 +475,8 @@ | |
| Used by: RemoveHtmlTags converter</p> | |
| </dd> | |
| <dt><code id="option-remove-span-html-tags">remove_span_html_tags</code></dt> | |
| - <dd>Remove span HTML tags | |
| + <dd> | |
| + <p>Remove span HTML tags</p> | |
| <p>If this option is <code>true</code>, the RemoveHtmlTags converter removes | |
| span HTML tags.</p> | |
| @@ -456,7 +485,8 @@ | |
| Used by: RemoveHtmlTags converter</p> | |
| </dd> | |
| <dt><code id="option-smart-quotes">smart_quotes</code></dt> | |
| - <dd>Defines the HTML entity names or code points for smart quote output | |
| + <dd> | |
| + <p>Defines the HTML entity names or code points for smart quote output</p> | |
| <p>The entities identified by entity name or code point that should be | |
| used for, in order, a left single quote, a right single quote, a left | |
| @@ -467,7 +497,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter">syntax_highlighter</code></dt> | |
| - <dd>Set the syntax highlighter | |
| + <dd> | |
| + <p>Set the syntax highlighter</p> | |
| <p>Specifies the syntax highlighter that should be used for highlighting | |
| code blocks and spans. If this option is set to +nil+, no syntax | |
| @@ -480,7 +511,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-syntax-highlighter-opts">syntax_highlighter_opts</code></dt> | |
| - <dd>Set the syntax highlighter options | |
| + <dd> | |
| + <p>Set the syntax highlighter options</p> | |
| <p>Specifies options for the syntax highlighter set via the | |
| syntax_highlighter configuration option.</p> | |
| @@ -492,8 +524,9 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-template">template</code></dt> | |
| - <dd>The name of an ERB template file that should be used to wrap the output | |
| -or the ERB template itself. | |
| + <dd> | |
| + <p>The name of an ERB template file that should be used to wrap the output | |
| +or the ERB template itself.</p> | |
| <p>This is used to wrap the output in an environment so that the output can | |
| be used as a stand-alone document. For example, an HTML template would | |
| @@ -516,7 +549,8 @@ | |
| Used by: all converters</p> | |
| </dd> | |
| <dt><code id="option-toc-levels">toc_levels</code></dt> | |
| - <dd>Defines the levels that are used for the table of contents | |
| + <dd> | |
| + <p>Defines the levels that are used for the table of contents</p> | |
| <p>The individual levels can be specified by separating them with commas | |
| (e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the | |
| @@ -526,7 +560,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-transliterated-header-ids">transliterated_header_ids</code></dt> | |
| - <dd>Transliterate the header text before generating the ID | |
| + <dd> | |
| + <p>Transliterate the header text before generating the ID</p> | |
| <p>Only ASCII characters are used in headers IDs. This is not good for | |
| languages with many non-ASCII characters. By enabling this option | |
| @@ -539,7 +574,8 @@ | |
| Used by: HTML/Latex converter</p> | |
| </dd> | |
| <dt><code id="option-typographic-symbols">typographic_symbols</code></dt> | |
| - <dd>Defines a mapping from typographical symbol to output characters | |
| + <dd> | |
| + <p>Defines a mapping from typographical symbol to output characters</p> | |
| <p>Typographical symbols are normally output using their equivalent Unicode | |
| codepoint. However, sometimes one wants to change the output, mostly to | |
| diff -ru htmldoc-old/parser/gfm.html htmldoc-new/parser/gfm.html | |
| --- htmldoc-old/parser/gfm.html 2018-01-01 14:28:45.000000000 +0100 | |
| +++ htmldoc-new/parser/gfm.html 2018-01-01 14:28:11.000000000 +0100 | |
| @@ -147,7 +147,8 @@ | |
| <dl> | |
| <dt><code id="option-hard-wrap">hard_wrap</code></dt> | |
| - <dd>Interprets line breaks literally | |
| + <dd> | |
| + <p>Interprets line breaks literally</p> | |
| <p>Insert HTML <code><br /></code> tags inside paragraphs where the original Markdown | |
| document had newlines (by default, Markdown ignores these newlines).</p> | |
| @@ -156,7 +157,8 @@ | |
| Used by: GFM parser</p> | |
| </dd> | |
| <dt><code id="option-gfm-quirks">gfm_quirks</code></dt> | |
| - <dd>Enables a set of GFM specific quirks | |
| + <dd> | |
| + <p>Enables a set of GFM specific quirks</p> | |
| <p>The way how GFM is transformed on Github often differs from the way | |
| kramdown does things. Many of these differences are negligible but | |
| diff -ru htmldoc-old/parser/kramdown.html htmldoc-new/parser/kramdown.html | |
| --- htmldoc-old/parser/kramdown.html 2018-01-01 14:28:45.000000000 +0100 | |
| +++ htmldoc-new/parser/kramdown.html 2018-01-01 14:28:11.000000000 +0100 | |
| @@ -131,7 +131,8 @@ | |
| <dl> | |
| <dt><code id="option-parse-block-html">parse_block_html</code></dt> | |
| - <dd>Process kramdown syntax in block HTML tags | |
| + <dd> | |
| + <p>Process kramdown syntax in block HTML tags</p> | |
| <p>If this option is <code>true</code>, the kramdown parser processes the content of | |
| block HTML tags as text containing block-level elements. Since this is | |
| @@ -142,7 +143,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-parse-span-html">parse_span_html</code></dt> | |
| - <dd>Process kramdown syntax in span HTML tags | |
| + <dd> | |
| + <p>Process kramdown syntax in span HTML tags</p> | |
| <p>If this option is <code>true</code>, the kramdown parser processes the content of | |
| span HTML tags as text containing span-level elements.</p> | |
| @@ -151,7 +153,8 @@ | |
| Used by: kramdown parser</p> | |
| </dd> | |
| <dt><code id="option-html-to-native">html_to_native</code></dt> | |
| - <dd>Convert HTML elements to native elements | |
| + <dd> | |
| + <p>Convert HTML elements to native elements</p> | |
| <p>If this option is <code>true</code>, the parser converts HTML elements to native | |
| elements. For example, when parsing <code><em>hallo</em></code> the emphasis tag | |
| diff -ru htmldoc-old/syntax_highlighter/rouge.html htmldoc-new/syntax_highlighter/rouge.html | |
| --- htmldoc-old/syntax_highlighter/rouge.html 2018-01-01 14:28:46.000000000 +0100 | |
| +++ htmldoc-new/syntax_highlighter/rouge.html 2018-01-01 14:27:58.000000000 +0100 | |
| @@ -79,14 +79,16 @@ | |
| <dt>default_lang</dt> | |
| <dd>The default language that should be used when no language is set.</dd> | |
| <dt>formatter</dt> | |
| - <dd>A custom Rouge formatter class that should be used instead of the following default formatter | |
| -(Rogue 1.x: <code>Rouge::Formatters::HTML</code> / Rogue 2.x: <code>Rouge::Formatters::HTMLLegacy</code>). | |
| + <dd> | |
| + <p>A custom Rouge formatter class that should be used instead of the following default formatter | |
| +(Rogue 1.x: <code>Rouge::Formatters::HTML</code> / Rogue 2.x: <code>Rouge::Formatters::HTMLLegacy</code>).</p> | |
| <p>If this setting is a string, it needs to contain the name of a constant under the | |
| <code>Rouge::Formatters</code> namespace.</p> | |
| </dd> | |
| <dt>disable</dt> | |
| - <dd>If set to <code>true</code>, highlighting with Rouge will be disabled. | |
| + <dd> | |
| + <p>If set to <code>true</code>, highlighting with Rouge will be disabled.</p> | |
| <p>Should probably not be set globally but inside the ‘span’ or ‘block’ options.</p> | |
| </dd> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment