<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>6. Interaction with Documenter.jl · Literate.jl</title><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/fontawesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/solid.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/brands.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL="."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="assets/documenter.js"></script><scriptsrc="siteinfo.js"></script><scriptsrc="../versions.js"></script><linkhref="assets/custom.css"rel="stylesheet"type="text/css"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="assets/themes/documenter-dark.css"data-theme-name="documenter-dark"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="assets/themes/documenter-light.css"data-theme-name="documenter-light"data-theme-primary/><scriptsrc="assets/themeswap.js"></script></head><body><divid="documenter"><navclass="docs-sidebar"><aclass="docs-logo"href="index.html"><imgsrc="assets/logo.png"alt="Literate.jl logo"/></a><divclass="docs-package-name"><spanclass="docs-autofit">Literate.jl</span></div><formclass="docs-search"action="search.html"><inputclass="docs-search-query"id="documenter-search-query"name="q"type="text"placeholder="Search docs"/></form><ulclass="docs-menu"><li><aclass="tocitem"href="index.html"><strong>1.</strong> Introduction</a></li><li><aclass="tocitem"href="fileformat.html"><strong>2.</strong> File Format</a></li><li><aclass="tocitem"href="pipeline.html"><strong>3.</strong> Processing pipeline</a></li><li><aclass="tocitem"href="outputformats.html"><strong>4.</strong> Output Formats</a></li><li><aclass="tocitem"href="customprocessing.html"><strong>5.</strong> Custom pre- and post-processing</a></li><liclass="is-active"><aclass="tocitem"href="documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li><li><aclass="tocitem"href="generated/example.html"><strong>7.</strong> Example</a></li></ul><divclass="docs-version-selector field has-addons"><divclass="control"><spanclass="docs-label button is-static is-size-7">Version</span></div><divclass="docs-selector control is-expanded"><divclass="select is-fullwidth is-size-7"><selectid="documenter-version-selector"></select></div></div></div></nav><divclass="docs-main"><headerclass="docs-navbar"><navclass="breadcrumb"><ulclass="is-hidden-mobile"><liclass="is-active"><ahref="documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li></ul><ulclass="is-hidden-tablet"><liclass="is-active"><ahref="documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li></ul></nav><divclass="docs-right"><aclass="docs-edit-link"href="https://github.com/fredrikekre/Literate.jl/blob/master/docs/src/documenter.md"title="Edit on GitHub"><spanclass="docs-icon fab"></span><spanclass="docs-label is-hidden-touch">Edit on GitHub</span></a><aclass="docs-settings-button fas fa-cog"id="documenter-settings-button"href="#"title="Settings"></a><aclass="docs-sidebar-button fa fa-bars is-hidden-desktop"id="documenter-sidebar-button"href="#"></a></div></header><articleclass="content"id="documenter-page"><h1id="Interaction-with-Documenter-1"><strong>6.</strong> Interaction with Documenter.jl<aclass="docs-heading-anchor"href="#Interaction-with-Documenter-1"title="Permalink"></a></h1><p>Literate can be used for any purpose, it spits out regular markdown files, and notebooks. Typically, though, these files will be used to render documentation for your package. The generators (<ahref="outputformats.html#Literate.markdown"><code>Literate.markdown</code></a>, <ahref="outputformats.html#Literate.notebook"><code>Literate.notebook</code></a> and <ahref="outputformats.html#Literate.script"><code>Literate.script</code></a>) supports a keyword argument <code>documenter</code> that lets the generator perform some extra things, keeping in mind that the source code have been written with Documenter.jl in mind. So lets take a look at what will happen if we set <code>documenter = true</code>:</p><h3id="[Literate.markdown](@ref):-1"><ahref="outputformats.html#Literate.markdown"><code>Literate.markdown</code></a>:<aclass="docs-heading-anchor"href="#[Literate.markdown](@ref):-1"title="Permalink"></a></h3><ul><li>The default code fence will change from<pre><codeclass="language-none">```julia
```</code></pre></li><li>The following <code>@meta</code> block will be added to the top of the markdown page, which redirects the "Edit on GitHub" link on the top of the page to the <em>source file</em> rather than the generated <code>.md</code> file:<pre><codeclass="language-none">```@meta
```</code></pre></li></ul><h3id="[Literate.notebook](@ref):-1"><ahref="outputformats.html#Literate.notebook"><code>Literate.notebook</code></a>:<aclass="docs-heading-anchor"href="#[Literate.notebook](@ref):-1"title="Permalink"></a></h3><ul><li>Documenter style <code>@ref</code>s and <code>@id</code> will be removed. This means that you can use <code>@ref</code> and <code>@id</code> in the source file without them leaking to the notebook.</li><li>Documenter style markdown math<pre><codeclass="language-none">```math
\int f dx
```</code></pre>is replaced with notebook compatible<pre><codeclass="language-none">$$
\int f dx
$$</code></pre></li></ul><h3id="[Literate.script](@ref):-1"><ahref="outputformats.html#Literate.script"><code>Literate.script</code></a>:<aclass="docs-heading-anchor"href="#[Literate.script](@ref):-1"title="Permalink"></a></h3><ul><li>Documenter style <code>@ref</code>s and <code>@id</code> will be removed. This means that you can use <code>@ref</code> and <code>@id</code> in the source file without them leaking to the script.</li></ul></article><navclass="docs-footer"><aclass="docs-footer-prevpage"href="customprocessing.html">« <strong>5.</strong> Custom pre- and post-processing</a><aclass="docs-footer-nextpage"href="generated/example.html"><strong>7.</strong> Example »</a></nav></div><divclass="modal"id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <spanclass="colophon-date"title="Saturday 16 November 2019 01:19">Saturday 16 November 2019</span>. Using Julia version 1.2.0.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>6. Interaction with Documenter.jl · Literate.jl</title><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/fontawesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/solid.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/brands.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL=".."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="../assets/documenter.js"></script><scriptsrc="../siteinfo.js"></script><scriptsrc="../../versions.js"></script><linkhref="../assets/custom.css"rel="stylesheet"type="text/css"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-dark.css"data-theme-name="documenter-dark"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-light.css"data-theme-name="documenter-light"data-theme-primary/><scriptsrc="../assets/themeswap.js"></script></head><body><divid="documenter"><navclass="docs-sidebar"><aclass="docs-logo"href="../"><imgsrc="../assets/logo.png"alt="Literate.jl logo"/></a><divclass="docs-package-name"><spanclass="docs-autofit">Literate.jl</span></div><formclass="docs-search"action="../search/"><inputclass="docs-search-query"id="documenter-search-query"name="q"type="text"placeholder="Search docs"/></form><ulclass="docs-menu"><li><aclass="tocitem"href="../"><strong>1.</strong> Introduction</a></li><li><aclass="tocitem"href="../fileformat/"><strong>2.</strong> File Format</a></li><li><aclass="tocitem"href="../pipeline/"><strong>3.</strong> Processing pipeline</a></li><li><aclass="tocitem"href="../outputformats/"><strong>4.</strong> Output Formats</a></li><li><aclass="tocitem"href="../customprocessing/"><strong>5.</strong> Custom pre- and post-processing</a></li><liclass="is-active"><aclass="tocitem"href><strong>6.</strong> Interaction with Documenter.jl</a></li><li><aclass="tocitem"href="../generated/example/"><strong>7.</strong> Example</a></li></ul><divclass="docs-version-selector field has-addons"><divclass="control"><spanclass="docs-label button is-static is-size-7">Version</span></div><divclass="docs-selector control is-expanded"><divclass="select is-fullwidth is-size-7"><selectid="documenter-version-selector"></select></div></div></div></nav><divclass="docs-main"><headerclass="docs-navbar"><navclass="breadcrumb"><ulclass="is-hidden-mobile"><liclass="is-active"><ahref><strong>6.</strong> Interaction with Documenter.jl</a></li></ul><ulclass="is-hidden-tablet"><liclass="is-active"><ahref><strong>6.</strong> Interaction with Documenter.jl</a></li></ul></nav><divclass="docs-right"><aclass="docs-edit-link"href="https://github.com/fredrikekre/Literate.jl/blob/master/docs/src/documenter.md"title="Edit on GitHub"><spanclass="docs-icon fab"></span><spanclass="docs-label is-hidden-touch">Edit on GitHub</span></a><aclass="docs-settings-button fas fa-cog"id="documenter-settings-button"href="#"title="Settings"></a><aclass="docs-sidebar-button fa fa-bars is-hidden-desktop"id="documenter-sidebar-button"href="#"></a></div></header><articleclass="content"id="documenter-page"><h1id="Interaction-with-Documenter-1"><strong>6.</strong> Interaction with Documenter.jl<aclass="docs-heading-anchor"href="#Interaction-with-Documenter-1"title="Permalink"></a></h1><p>Literate can be used for any purpose, it spits out regular markdown files, and notebooks. Typically, though, these files will be used to render documentation for your package. The generators (<ahref="../outputformats/#Literate.markdown"><code>Literate.markdown</code></a>, <ahref="../outputformats/#Literate.notebook"><code>Literate.notebook</code></a> and <ahref="../outputformats/#Literate.script"><code>Literate.script</code></a>) supports a keyword argument <code>documenter</code> that lets the generator perform some extra things, keeping in mind that the source code have been written with Documenter.jl in mind. So lets take a look at what will happen if we set <code>documenter = true</code>:</p><h3id="[Literate.markdown](@ref):-1"><ahref="../outputformats/#Literate.markdown"><code>Literate.markdown</code></a>:<aclass="docs-heading-anchor"href="#[Literate.markdown](@ref):-1"title="Permalink"></a></h3><ul><li>The default code fence will change from<pre><codeclass="language-none">```julia
```</code></pre></li><li>The following <code>@meta</code> block will be added to the top of the markdown page, which redirects the "Edit on GitHub" link on the top of the page to the <em>source file</em> rather than the generated <code>.md</code> file:<pre><codeclass="language-none">```@meta
```</code></pre></li></ul><h3id="[Literate.notebook](@ref):-1"><ahref="../outputformats/#Literate.notebook"><code>Literate.notebook</code></a>:<aclass="docs-heading-anchor"href="#[Literate.notebook](@ref):-1"title="Permalink"></a></h3><ul><li>Documenter style <code>@ref</code>s and <code>@id</code> will be removed. This means that you can use <code>@ref</code> and <code>@id</code> in the source file without them leaking to the notebook.</li><li>Documenter style markdown math<pre><codeclass="language-none">```math
\int f dx
```</code></pre>is replaced with notebook compatible<pre><codeclass="language-none">$$
\int f dx
$$</code></pre></li></ul><h3id="[Literate.script](@ref):-1"><ahref="../outputformats/#Literate.script"><code>Literate.script</code></a>:<aclass="docs-heading-anchor"href="#[Literate.script](@ref):-1"title="Permalink"></a></h3><ul><li>Documenter style <code>@ref</code>s and <code>@id</code> will be removed. This means that you can use <code>@ref</code> and <code>@id</code> in the source file without them leaking to the script.</li></ul></article><navclass="docs-footer"><aclass="docs-footer-prevpage"href="../customprocessing/">« <strong>5.</strong> Custom pre- and post-processing</a><aclass="docs-footer-nextpage"href="../generated/example/"><strong>7.</strong> Example »</a></nav></div><divclass="modal"id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <spanclass="colophon-date"title="Saturday 16 November 2019 01:26">Saturday 16 November 2019</span>. Using Julia version 1.2.0.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>Search · Literate.jl</title><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/fontawesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/solid.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/brands.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL="."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="assets/documenter.js"></script><scriptsrc="siteinfo.js"></script><scriptsrc="../versions.js"></script><linkhref="assets/custom.css"rel="stylesheet"type="text/css"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="assets/themes/documenter-dark.css"data-theme-name="documenter-dark"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="assets/themes/documenter-light.css"data-theme-name="documenter-light"data-theme-primary/><scriptsrc="assets/themeswap.js"></script></head><body><divid="documenter"><navclass="docs-sidebar"><aclass="docs-logo"href="index.html"><imgsrc="assets/logo.png"alt="Literate.jl logo"/></a><divclass="docs-package-name"><spanclass="docs-autofit">Literate.jl</span></div><formclass="docs-search"action="search.html"><inputclass="docs-search-query"id="documenter-search-query"name="q"type="text"placeholder="Search docs"/></form><ulclass="docs-menu"><li><aclass="tocitem"href="index.html"><strong>1.</strong> Introduction</a></li><li><aclass="tocitem"href="fileformat.html"><strong>2.</strong> File Format</a></li><li><aclass="tocitem"href="pipeline.html"><strong>3.</strong> Processing pipeline</a></li><li><aclass="tocitem"href="outputformats.html"><strong>4.</strong> Output Formats</a></li><li><aclass="tocitem"href="customprocessing.html"><strong>5.</strong> Custom pre- and post-processing</a></li><li><aclass="tocitem"href="documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li><li><aclass="tocitem"href="generated/example.html"><strong>7.</strong> Example</a></li></ul><divclass="docs-version-selector field has-addons"><divclass="control"><spanclass="docs-label button is-static is-size-7">Version</span></div><divclass="docs-selector control is-expanded"><divclass="select is-fullwidth is-size-7"><selectid="documenter-version-selector"></select></div></div></div></nav><divclass="docs-main"><headerclass="docs-navbar"><navclass="breadcrumb"><ulclass="is-hidden-mobile"><liclass="is-active"><ahref="search.html">Search</a></li></ul><ulclass="is-hidden-tablet"><liclass="is-active"><ahref="search.html">Search</a></li></ul></nav><divclass="docs-right"><aclass="docs-settings-button fas fa-cog"id="documenter-settings-button"href="#"title="Settings"></a><aclass="docs-sidebar-button fa fa-bars is-hidden-desktop"id="documenter-sidebar-button"href="#"></a></div></header><article><pid="documenter-search-info">Loading search...</p><ulid="documenter-search-results"></ul></article></div><divclass="modal"id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <spanclass="colophon-date"title="Saturday 16 November 2019 01:19">Saturday 16 November 2019</span>. Using Julia version 1.2.0.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body><scriptsrc="search_index.js"></script><scriptsrc="assets/search.js"></script></html>
<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>Search · Literate.jl</title><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/fontawesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/solid.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/brands.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL=".."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="../assets/documenter.js"></script><scriptsrc="../siteinfo.js"></script><scriptsrc="../../versions.js"></script><linkhref="../assets/custom.css"rel="stylesheet"type="text/css"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-dark.css"data-theme-name="documenter-dark"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-light.css"data-theme-name="documenter-light"data-theme-primary/><scriptsrc="../assets/themeswap.js"></script></head><body><divid="documenter"><navclass="docs-sidebar"><aclass="docs-logo"href="../"><imgsrc="../assets/logo.png"alt="Literate.jl logo"/></a><divclass="docs-package-name"><spanclass="docs-autofit">Literate.jl</span></div><formclass="docs-search"action><inputclass="docs-search-query"id="documenter-search-query"name="q"type="text"placeholder="Search docs"/></form><ulclass="docs-menu"><li><aclass="tocitem"href="../"><strong>1.</strong> Introduction</a></li><li><aclass="tocitem"href="../fileformat/"><strong>2.</strong> File Format</a></li><li><aclass="tocitem"href="../pipeline/"><strong>3.</strong> Processing pipeline</a></li><li><aclass="tocitem"href="../outputformats/"><strong>4.</strong> Output Formats</a></li><li><aclass="tocitem"href="../customprocessing/"><strong>5.</strong> Custom pre- and post-processing</a></li><li><aclass="tocitem"href="../documenter/"><strong>6.</strong> Interaction with Documenter.jl</a></li><li><aclass="tocitem"href="../generated/example/"><strong>7.</strong> Example</a></li></ul><divclass="docs-version-selector field has-addons"><divclass="control"><spanclass="docs-label button is-static is-size-7">Version</span></div><divclass="docs-selector control is-expanded"><divclass="select is-fullwidth is-size-7"><selectid="documenter-version-selector"></select></div></div></div></nav><divclass="docs-main"><headerclass="docs-navbar"><navclass="breadcrumb"><ulclass="is-hidden-mobile"><liclass="is-active"><ahref>Search</a></li></ul><ulclass="is-hidden-tablet"><liclass="is-active"><ahref>Search</a></li></ul></nav><divclass="docs-right"><aclass="docs-settings-button fas fa-cog"id="documenter-settings-button"href="#"title="Settings"></a><aclass="docs-sidebar-button fa fa-bars is-hidden-desktop"id="documenter-sidebar-button"href="#"></a></div></header><article><pid="documenter-search-info">Loading search...</p><ulid="documenter-search-results"></ul></article></div><divclass="modal"id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <spanclass="colophon-date"title="Saturday 16 November 2019 01:26">Saturday 16 November 2019</span>. Using Julia version 1.2.0.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body><scriptsrc="../search_index.js"></script><scriptsrc="../assets/search.js"></script></html>
zeptodoctor
6 years ago