Browse Source

Updated docs

gh-pages
Frans Bouma 5 years ago
parent
commit
c4849f81d5
2 changed files with 2 additions and 2 deletions
  1. +1
    -1
      h2leveldiscovery.htm
  2. +1
    -1
      markdownsupport.htm

+ 1
- 1
h2leveldiscovery.htm View File

@@ -80,7 +80,7 @@
<div class="section">
<h1 id="automatic-h2-level-toc-entry-discovery">Automatic H2 level ToC entry discovery<a class="headerlink" href="#automatic-h2-level-toc-entry-discovery" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
<p><code>Docnet</code> will automatically add all H2 (<code>##</code> marked) headers to the ToC as sub navigation elements below a page ToC item. It will automatically add anchors to these H2 headers in the HTML output for the page as well. This makes it very easy to create a fine-grained ToC for easy discovery.</p>
<p>This behavior can be overridden by the <code>MaxLevelInToC</code> <a href="./docnetjson.md">configuration option</a>.</p>
<p>This behavior can be overridden by the <code>MaxLevelInToC</code> <a href="./docnetjson.htm">configuration option</a>.</p>
<div class="alert alert-info"><span class="alert-title"><i class="fa fa-info-circle"></i> Info</span><p>Note that level 1 headings (titles) are never shown in the ToC).</p>
</div>
</div>


+ 1
- 1
markdownsupport.htm View File

@@ -206,7 +206,7 @@ If you want to have an image rendered centered with a note below it, simply spec
<p>To specify a block of text in a fixed sized font but not specify any language highlighting, specify <code>nohighlight</code> as language name:</p>
<pre class="nocode">this is a simple &lt;pre&gt; block
</pre><h2 id="linking">Linking<a class="headerlink" href="#linking" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
<p><code>Docnet</code> doesn't automatically transform links to markdown files by default. To enable automatic link conversion to local markdown files, please specify the <code>ConvertLocalLinks</code> option in the <a href="docnetjson.md">docnet.json file</a> file with the value <code>true</code>. If <code>ConvertLocalLinks</code> isn't specified or set to <code>false</code>, any link to any document in your documentation has to use the url it will get in the destination folder. </p>
<p><code>Docnet</code> doesn't automatically transform links to markdown files by default. To enable automatic link conversion to local markdown files, please specify the <code>ConvertLocalLinks</code> option in the <a href="docnetjson.htm">docnet.json file</a> file with the value <code>true</code>. If <code>ConvertLocalLinks</code> isn't specified or set to <code>false</code>, any link to any document in your documentation has to use the url it will get in the destination folder. </p>
<p>Example: you want to link to the file <code>How to\AddEntity.md</code> from a page. If <code>ConvertLocalLinks</code> isn't specified or set to <code>false</code>, you have to specify in the markdown the url it will need to be in the result site, which is the link <code>How%20to/AddEntity.htm</code>. If <code>ConvertLocalLinks</code> is set to <code>true</code>, you can specify <code>How%20to/AddEntity.md</code> and DocNet will convert it to <code>How%20to/AddEntity.htm</code>.</p>
<div class="alert alert-warning"><span class="alert-title"><i class="fa fa-warning"></i> Important!</span><p>The markdown parser also doesn't allow spaces to be present in the urls. If you need a space in the url, escape it with <code>%20</code>. </p>
</div>


Loading…
Cancel
Save