| @@ -40,6 +40,8 @@ | |||
| </li> | |||
| <li class="tocentry"><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a> | |||
| </li> | |||
| <li class="tocentry"><a href="notfound.htm">Not found (404) page</a> | |||
| </li> | |||
| </ul> | |||
| </li> | |||
| @@ -82,6 +84,7 @@ | |||
| <ul> | |||
| <li><a href="docnetjson.htm">Site configuration with the docnet.json file</a></li> | |||
| <li><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a></li> | |||
| <li><a href="notfound.htm">Not found (404) page</a></li> | |||
| </ul> | |||
| </div> | |||
| @@ -67,8 +67,8 @@ Determines the way (md) paths are treated by the tooling. The default value is ` | |||
| Determines how the urls are formatted. The default value is `None` which will only remove unsupported characters from the urls. | |||
| * `None`: Does not touch the urls except from removing unsupported characters from the urls. | |||
| * `Strip`: Replaces all non-text characters (e.g. spaces, dots, commands, etc) by an empty string (e.g. `/my-documentation/Some Introduction.md` results in `/mydocumentation/someintroduction.htm`) | |||
| * `Dashes`: Replaces all non-text characters (e.g. spaces, dots, commands, etc) by a dash (`-`) (e.g. `/my-documentation/Some Introduction.md` results in `/my-documentation/some-introduction.htm`) | |||
| * `Strip`: Replaces all non-text characters (e.g. spaces, dots, commas, etc) by an empty string (e.g. `/my-documentation/Some Introduction.md` results in `/mydocumentation/someintroduction.htm`) | |||
| * `Dashes`: Replaces all non-text characters (e.g. spaces, dots, commas, etc) by a dash (`-`) (e.g. `/my-documentation/Some Introduction.md` results in `/my-documentation/some-introduction.htm`) | |||
| ### MaxLevelInToC | |||
| Sets the level of headings to show in the Table of Contents (ToC). The default value is `2`. To show one additional level, one would use `3` for this value. | |||
| @@ -54,6 +54,8 @@ | |||
| <li class="tocentry"><a href="#pathspecification">PathSpecification</a></li> | |||
| <li class="tocentry"><a href="#urlformatting">UrlFormatting</a></li> | |||
| <li class="tocentry"><a href="#maxlevelintoc">MaxLevelInToC</a></li> | |||
| <li class="tocentry"><a href="#stripindexhtm">StripIndexHtm</a></li> | |||
| @@ -71,6 +73,8 @@ | |||
| </ul> | |||
| <li class="tocentry"><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a> | |||
| </li> | |||
| <li class="tocentry"><a href="notfound.htm">Not found (404) page</a> | |||
| </li> | |||
| </ul> | |||
| </li> | |||
| @@ -120,6 +124,7 @@ | |||
| "Footer" : "footer text or HTML", | |||
| "ConvertLocalLinks: "true" | "false", | |||
| "PathSpecification": "Full" | "Relative" | "RelativeAsFolder", | |||
| "UrlFormatting": "None" | "Strip" | "Dashes", | |||
| "MaxLevelInToC": "3", | |||
| "StripIndexHtm": "true" | "false", | |||
| "Pages" : | |||
| @@ -160,6 +165,13 @@ | |||
| <li><code>Relative</code>: Assumes that all paths are relative paths. All auto-generated index files will be put in the right (sub)folder.</li> | |||
| <li><code>RelativeAsFolder</code>: Behaves the same as <code>Relative</code>, but puts <em>every</em> source md in its own folder resulting in clean navigation urls (e.g. <code>/getting-started/introduction.htm</code> becomes <code>/getting-started/introduction/index.htm</code>)</li> | |||
| </ul> | |||
| <h3 id="urlformatting">UrlFormatting<a class="headerlink" href="#urlformatting" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>Determines how the urls are formatted. The default value is <code>None</code> which will only remove unsupported characters from the urls.</p> | |||
| <ul> | |||
| <li><code>None</code>: Does not touch the urls except from removing unsupported characters from the urls.</li> | |||
| <li><code>Strip</code>: Replaces all non-text characters (e.g. spaces, dots, commas, etc) by an empty string (e.g. <code>/my-documentation/Some Introduction.md</code> results in <code>/mydocumentation/someintroduction.htm</code>) </li> | |||
| <li><code>Dashes</code>: Replaces all non-text characters (e.g. spaces, dots, commas, etc) by a dash (<code>-</code>) (e.g. <code>/my-documentation/Some Introduction.md</code> results in <code>/my-documentation/some-introduction.htm</code>) </li> | |||
| </ul> | |||
| <h3 id="maxlevelintoc">MaxLevelInToC<a class="headerlink" href="#maxlevelintoc" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>Sets the level of headings to show in the Table of Contents (ToC). The default value is <code>2</code>. To show one additional level, one would use <code>3</code> for this value. </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> | |||
| @@ -40,6 +40,8 @@ | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a> | |||
| </li> | |||
| <li class="tocentry"><a href="notfound.htm">Not found (404) page</a> | |||
| </li> | |||
| </ul> | |||
| </li> | |||
| @@ -9,7 +9,7 @@ | |||
| { | |||
| "location": "docnetjson.htm", | |||
| "breadcrumbs": "Home / Configuration / Site configuration with the docnet.json file", | |||
| "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation doesn e E each Each elements empty end ending entry escape every example Example executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format forward from full Full g generate Generate generated getting given guarantees has have header Header headings Home href htm HTML if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction is isn it It its json later lead level Levels line link links list load loaded local located make markdown markdownextensions marker MaxLevelInToC md more mostly name Name nameoflevel names navigated navigation never no non Non not Note of off one only optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove result resulting retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so somemarkdownfile source Source sourcefolder SourceFoldersToCopy special specified Specifies specify started starting still straight string strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle treated tree true unique urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", | |||
| "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined commas compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create dash Dashes default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation Does doesn dots e E each Each elements empty end ending entry escape etc every example Example except executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format formatted forward from full Full g generate Generate generated getting given guarantees has have header Header headings Home how href htm HTML if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction Introduction is isn it It its json later lead level Levels line link links list load loaded local located make markdown markdownextensions marker MaxLevelInToC md more mostly my mydocumentation name Name nameoflevel names navigated navigation never no non Non None not Note of off one only optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove removing Replaces result resulting results retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so some Some someintroduction somemarkdownfile source Source sourcefolder SourceFoldersToCopy spaces special specified Specifies specify started starting still straight string strip Strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle touch treated tree true unique unsupported UrlFormatting urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", | |||
| "title": "Site configuration with the docnet.json file" | |||
| }, | |||
| { | |||
| @@ -18,6 +18,12 @@ | |||
| "keywords": "1 a add alert all anchors are as Automatic automatically be behavior below by can configuration create discovery Docnet docnetjson easy elements end entry fine for grained H2 headers headings HTML in info it It item level makes marked MaxLevelInToC md navigation never Note option output overridden page shown sub that the these This titles to ToC very well will", | |||
| "title": "Automatic H2 level ToC entry discovery" | |||
| }, | |||
| { | |||
| "location": "notfound.htm", | |||
| "breadcrumbs": "Home / Configuration / Not found (404) page", | |||
| "keywords": "404 a automatically be content create default destination Docnet file folder found generate generated htm If in is md named no not Not of page root source the to used will with", | |||
| "title": "Not found (404) page" | |||
| }, | |||
| { | |||
| "location": "themes.htm", | |||
| "breadcrumbs": "Home / Authoring content / Themes", | |||