rebuild of docs with v0.13

Authoringcontent.htm

@@ -78,7 +78,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="authoring-content">Authoring content</h1>
+<h1 id="authoring-content">Authoring content<a class="headerlink" href="#authoring-content" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>Please select one of the topics in this section:</p>
 <ul>
 <li><a href="themes.htm">Themes</a></li>

Configuration.htm

@@ -77,7 +77,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="configuration">Configuration</h1>
+<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>Please select one of the topics in this section:</p>
 <ul>
 <li><a href="docnetjson.htm">Site configuration with the docnet.json file</a></li>

WritingcontentusingMarkdown.htm

@@ -85,7 +85,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="writing-content-using-markdown">Writing content using Markdown</h1>
+<h1 id="writing-content-using-markdown">Writing content using Markdown<a class="headerlink" href="#writing-content-using-markdown" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>Please select one of the topics in this section:</p>
 <ul>
 <li><a href="markdownsupport.htm">Markdown support</a></li>

acknowledgements.htm

@@ -70,7 +70,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="acknowledgements">Acknowledgements</h1>
+<h1 id="acknowledgements">Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>This application wouldn't be possible without the work of others. The (likely incomplete) list below contains the work <code>Docnet</code> is based on / builds upon. </p>
 <ul>
 <li><a href="http://www.mkdocs.org/" target="_blank">MkDocs</a>. <code>Docnet</code> borrows a great deal from <code>MkDocs</code>: the theme css <code>Docnet</code> uses is based on a cleaned up version of their <code>Readthedocs</code> theme, as well as the javascript based search is from MkDocs. </li>

css/theme.css

@@ -136,6 +136,14 @@ a:hover, a:active {
 	outline: 0;
 }
 
+a.headerlink {
+	display: inline;
+	text-decoration: none;
+	visibility: hidden;
+	font-size: smaller;
+	margin-left: 3px;
+}
+
 abbr[title] {
 	border-bottom: 1px dotted;
 }
@@ -303,6 +311,30 @@ h6 {
 	margin-bottom: 7px;
 }
 
+h1:hover a.headerlink {
+	visibility: visible;
+}
+
+h2:hover a.headerlink {
+	visibility: visible;
+}
+
+h3:hover a.headerlink {
+	visibility: visible;
+}
+
+h4:hover a.headerlink {
+	visibility: visible;
+}
+
+h5:hover a.headerlink {
+	visibility: visible;
+}
+
+h6:hover a.headerlink {
+	visibility: visible;
+}
+
 hr {
 	display: block;
 	height: 1px;

docnetjson.htm

@@ -79,7 +79,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="the-configuration-file-docnet.json">The configuration file: 'docnet.json'</h1>
+<h1 id="the-configuration-file-docnet.json">The configuration file: 'docnet.json'<a class="headerlink" href="#the-configuration-file-docnet.json" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>DocNet uses a json file to determine what to do in what form. The format is straight forward and described below</p>
 <pre><code class="json">{
     &quot;Name&quot; : &quot;name of site&quot;,
@@ -117,7 +117,7 @@
 </ul>
 <p>Paths are expected to use <code>\</code> characters, and as it's json, you have to escape them, so the path <code>.\foo</code> becomes <code>.\\foo</code>.</p>
 <p>Each level, starting with the root, has a special page defined, <code>__index</code>. This page is the page shown when the level header (in the example above this is e.g. <em>Sub Header 1</em>) is clicked in the navigation. If <code>__index</code> is specified in the root level, it's assigned to the navigation name <code>Home</code>. If there's no <code>__index</code> specified, there will still be a page generated but it will have default content (See below). The names of the elements are case sensitive.</p>
-<h2 id="levels-without-index-defined">Levels without __index defined</h2>
+<h2 id="levels-without-index-defined">Levels without __index defined<a class="headerlink" href="#levels-without-index-defined" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>If a level has no <code>__index</code> defined, <code>DocNet</code> will create a <code>__index</code> entry for the level and will specify as target <code>&lt;path to index of parent&gt;/nameoflevel.md</code>. If the page exists it will be loaded as the content for the index of the level, if it doesn't exist, the HTML will simply contain the topictitle and a list of all the sub topics in the level. This guarantees the tree can always be navigated in full.  
</p>
 
                     </div>

h2leveldiscovery.htm

@@ -77,7 +77,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="automatic-h2-level-toc-entry-discovery">Automatic H2 level ToC entry discovery</h1>
+<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>
 
                     </div>

index.htm

@@ -70,10 +70,10 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="docnet">DocNet</h1>
+<h1 id="docnet">DocNet<a class="headerlink" href="#docnet" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>DocNet is a static site generator, mainly meant for user documentation, using markdown files to build the content. This site is generated with DocNet and is meant both as a showcase what you can do with the application and also contains the documentation for DocNet.</p>
 <p>To see the markdown source of this site, look at the <a href="https://github.com/FransBouma/DocNet/tree/gh-pages/MarkdownSource" target="_blank">MarkdownSource folder</a> in the <a href="https://github.com/FransBouma/DocNet/tree/gh-pages" target="_blank">gh-pages branch in the DocNet repository at <i class="fa fa-github"></i> GitHub</a></p>
-<h2 id="get-docnet">Get DocNet</h2>
+<h2 id="get-docnet">Get DocNet<a class="headerlink" href="#get-docnet" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>To get <code>DocNet</code>, either build it from source using the <a href="https://github.com/FransBouma/DocNet" target="_blank"><i class="fa fa-github"></i> github repository</a>, or download a pre-build binary package from the <a href="https://github.com/FransBouma/DocNet/releases" target="_blank">'Releases' section of the github repository</a></p>
 
                     </div>

license.htm

@@ -70,7 +70,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="license">License</h1>
+<h1 id="license">License<a class="headerlink" href="#license" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p><code>DocNet</code> is licensed under the following license:</p>
 <p>The MIT License (MIT)</p>
 <p>Copyright (c) 2016 Frans Bouma</p>

markdownextensions.htm

@@ -90,9 +90,9 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="docnet-markdown-extensions">DocNet Markdown extensions</h1>
+<h1 id="docnet-markdown-extensions">DocNet Markdown extensions<a class="headerlink" href="#docnet-markdown-extensions" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p><code>Docnet</code> defines the following markdown extensions to make writing documentation easier. </p>
-<h2 id="alert-boxes">Alert boxes</h2>
+<h2 id="alert-boxes">Alert boxes<a class="headerlink" href="#alert-boxes" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>To quickly define alert boxes, <code>Docnet</code> defines the <code>@alert</code> element. Three types of alerts are defined: <em>danger</em> (displayed in red), <em>warning</em> or <em>important</em> (displayed in yellow) and <em>info</em> or <em>neutral</em>, which is displayed in blue. You specify the type of the alert after the <code>@alert</code> statement using &#64;alert <em>name</em>. Close the <code>@alert</code> with <code>@end</code>.</p>
 <p>Below are examples for each alert box and the markdown used to create them. </p>
 <p>The markdown:</p>
@@ -125,10 +125,10 @@ This is a tip! It will be displayed in a tip alert box!
 @end
 </pre><p>Results in</p>
 <div class="alert alert-tip"><span class="alert-title"><i class="fa fa-info-circle"></i> Tip</span><p>This is a tip! It will be displayed in a tip alert box!</p>
-</div><h2 id="font-awesome-icons">Font Awesome icons</h2>
+</div><h2 id="font-awesome-icons">Font Awesome icons<a class="headerlink" href="#font-awesome-icons" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>To specify a font-awesome icon, use <code>@fa-iconname</code>, where <em>iconname</em> is the name of the font-awesome icon.</p>
 <p>Example: To specify the font awesome icon for GitHub, use <code>@fa-github</code>, which will result in: <i class="fa fa-github"></i></p>
-<h2 id="tabs">Tabs</h2>
+<h2 id="tabs">Tabs<a class="headerlink" href="#tabs" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>It's very easy with <code>Docnet</code> to add a tab control with one or more tabs to the HTML with a simple set of markdown statements. The tab statements are converted into pure CSS3/HTML tabs, based on the work of <a href="http://codepen.io/fusco/pen/Wvzjrm" target="_blank">Joseph Fusco</a>.</p>
 <p>To start a Tab control, start with <code>@tabs</code> and end the tabs definition with <code>@endtabs</code>. Between those two statements, which each need to be suffixed with a newline, you define one or more tabs using <code>@tab</code> followed by the label text for that tab, followed by a newline. End your tab contents with <code>@end</code>.</p>
 <p>The following example shows two tabs, one with label 'First Tab' and one with 'Second Tab':</p>
@@ -146,7 +146,7 @@ Now, the second tab however is very interesting. At least let's pretend it is!
 <div class="tab-wrap"><input type="radio" id="tab0_1" name="tabGroup1" class="tab" checked><label for="tab0_1">First Tab</label><input type="radio" id="tab1_1" name="tabGroup1" class="tab"><label for="tab1_1">Second Tab</label><div class="tab-content"><p>This is the text for the first tab. It's nothing special</p>
 <p>As you can see, it can deal with newlines as well. </p>
 </div><div class="tab-content"><p>Now, the second tab however is very interesting. At least let's pretend it is!</p>
-</div></div><h2 id="include-files">Include files</h2>
+</div></div><h2 id="include-files">Include files<a class="headerlink" href="#include-files" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>You can include other files in your markdown files using the directive <code>@@include(&quot;filename&quot;)</code>, where <code>filename</code> is the name of the file to include. The include system isn't recursive. 
 The files to include are read from a special folder, specified under <code>IncludeSource</code> in the <a href="docnetjson.htm">docnet.json</a> file. If no <code>IncludeSource</code> directive is
 specified in the <a href="docnetjson.htm">docnet.json</a> file, the folder <code>Includes</code> is assumed. </p>

markdownsupport.htm

@@ -90,17 +90,17 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="markdown-support">Markdown support</h1>
+<h1 id="markdown-support">Markdown support<a class="headerlink" href="#markdown-support" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p><code>DocNet</code> uses markdown files as input. The markdown is parsed with the markdown parser from topten software (called '<a href="http://www.toptensoftware.com/markdowndeep/" target="_blank">MarkdownDeep</a>'). It supports the default markdown statements as well as github style code block markers and specific extensions for writing documentation, which are described below.</p>
-<h2 id="standard-markdown">Standard Markdown</h2>
+<h2 id="standard-markdown">Standard Markdown<a class="headerlink" href="#standard-markdown" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>The standard markdown syntax as defined by <a href="https://daringfireball.net/projects/markdown/" target="_blank">John Gruber</a> is supported in full. </p>
-<h2 id="php-markdown-extra">Php Markdown Extra</h2>
+<h2 id="php-markdown-extra">Php Markdown Extra<a class="headerlink" href="#php-markdown-extra" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>MarkdownDeep supports <a href="https://michelf.ca/projects/php-markdown/extra/" target="_blank">PHP Markdown Extra</a>. PHP Markdown Extra comes with a set of neat extensions for markdown to define e.g. tables, footnotes and more. Please see the link above for all the syntax examples. Additionally, you can look at the <a href="https://github.com/FransBouma/DocNet/tree/master/src/MarkdownDeepTests/testfiles/extramode" target="_blank">unit test files</a> for MarkdownDeep in the <a href="https://github.com/FransBouma/DocNet" target="_blank">DocNet respository at GitHub</a>.  
</p>
 <p>A couple of examples are given below</p>
-<h3 id="footnotes">Footnotes</h3>
+<h3 id="footnotes">Footnotes<a class="headerlink" href="#footnotes" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>MarkdownDeep supports Footnotes, which can be added through the following system: To specify a footnote marker, specify <code>[^1]</code>, which will result in:<sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup></p>
 <p>The actual footnote text is then specified with <code>[^1]:</code> following the text of the actual footnote. Click on the superscript <code>1</code> link above to go to the footnote rendered at the bottom of this page. </p>
-<h3 id="definition-lists">Definition lists</h3>
+<h3 id="definition-lists">Definition lists<a class="headerlink" href="#definition-lists" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>To specify simple definition lists, simply do:</p>
 <pre class="nocode">Item one
 :   this is the description of item one
@@ -114,7 +114,7 @@ Item Two
 <dt>Item Two</dt>
 <dd>this is the text of item 2</dd>
 </dl>
-<h3 id="tables">Tables</h3>
+<h3 id="tables">Tables<a class="headerlink" href="#tables" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>There's basic support for defining tables. </p>
 <p>Specifying: </p>
 <pre class="nocode">Fruit|Color
@@ -150,14 +150,14 @@ Bongo|Bongo... it's a strange color, do you have a minute? It's a bit like the s
 </tr>
 </tbody>
 </table>
-<h3 id="special-attributes">Special attributes</h3>
+<h3 id="special-attributes">Special attributes<a class="headerlink" href="#special-attributes" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>DocNet supports special attributes for Links and Images. Currently this is supported on normal links/image specifications only, e.g.:</p>
 <pre class="nocode">![id text](imageurl){.cssclass1 .cssclass2 #idvalue name=value}
 </pre><p>which will result in:</p>
 <pre><code class="html">&lt;img src=&quot;imageurl&quot; alt=&quot;id text&quot; id=&quot;idvalue&quot; class=&quot;cssclass1 cssclass2&quot; name=&quot;value&quot; /&gt;
 </code></pre>
 
-<h3 id="image-rendering">Image rendering</h3>
+<h3 id="image-rendering">Image rendering<a class="headerlink" href="#image-rendering" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>By default images have no special rendering applied to them. To apply a shadow, specify '.shadowed' as css class in a special attribute specification. 
 If you want to have an image rendered centered with a note below it, simply specify a title for the image: </p>
 <pre class="nocode">![](mycenteredpicture.jpg &quot;this is a picture&quot;)
@@ -169,12 +169,12 @@ If you want to have an image rendered centered with a note below it, simply spec
 </code></pre>
 
 <p>All images rendered contain the width/height of the picture file included in the html.</p>
-<h3 id="abbreviations">Abbreviations</h3>
+<h3 id="abbreviations">Abbreviations<a class="headerlink" href="#abbreviations" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3>
 <p>There's also support for abbreviations, using the <code>&lt;abbr&gt;</code> HTML tag. </p>
 <p>Specifying:</p>
 <pre class="nocode">*[FuBar]: F**ked Up Beyond Any Repair.
 </pre><p>gives an abbreviation link in the following sentence: This is a test for abbreviations: <abbr title="F**ked Up Beyond Any Repair.">FuBar</abbr>.</p>
-<h2 id="highlighting-code">Highlighting code</h2>
+<h2 id="highlighting-code">Highlighting code<a class="headerlink" href="#highlighting-code" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>The markdown parser has been extended with GitHub code specifications, so it's easy to specify a specific code beautifying based on a language. This feature uses the <a href="https://highlightjs.org/" target="_blank">Highlight.js</a> javascript library and most popular languages are included. </p>
 <p>Example: to specify a codeblock as C#, append <code>cs</code> after the first ``` marker:</p>
 <pre><code class="cs">var i=42;
@@ -182,7 +182,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</h2>
+</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 transform links. This means that any link to any document in your documentation has to use the url it will get in the destination folder. Example: you want to link to the file <code>How to\AddEntity.md</code> from a page. In the result site this should be the link <code>How%20to/AddEntity.htm</code>, which you should specify in your markdown. In the future it might be <code>docnet</code> will be updated with link transformation, at the moment it doesn't convert any links besides the usual markdown ones. 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 class="footnotes">

search.htm

@@ -70,7 +70,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="search">Search</h1>
+<h1 id="search">Search<a class="headerlink" href="#search" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p><code>Docnet</code> will generate a search_data.json file in the root of the destination folder which is used with the javascript based search. It's a simple text search which can locate pages based on the word/sentence specified and will list them in first come first served order. For general purposes of locating a general piece of documentation regarding a topic it's good enough.</p>
 <p><em>NOTE</em>: Search locally on a file:/// served site won't work in Chrome, due to cross-origin protection because the search loads the search index and a template from disk in javascript. Either use Firefox or use the site with a server.</p>
 

themes.htm

@@ -82,13 +82,13 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="themes">Themes</h1>
+<h1 id="themes">Themes<a class="headerlink" href="#themes" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p><code>Docnet</code> uses themes to produce output in a certain form. A theme is a folder within the <code>Themes</code> folder which contains a <code>PageTemplate.htm</code> file and a <code>Destination</code> folder which contains zero or more folders and files which have to be copied to the <code>Destination</code> folder specified in the <code>docnet.json</code> file. </p>
-<h2 id="themes-folder">Themes folder</h2>
+<h2 id="themes-folder">Themes folder<a class="headerlink" href="#themes-folder" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p><code>Docnet</code> expects the <code>Themes</code> folder to be located in the folder where the executable is started from. This means that if you build <code>Docnet</code> from source, you have to manually copy the Themes folder to the folder your binary is located. To make development easier, you could create a <code>junction</code> in the bin\debug or bin\release folder to the Themes folder in the source repository, using <code>mklink</code> on a windows command prompt.</p>
-<h2 id="default-theme">Default theme</h2>
+<h2 id="default-theme">Default theme<a class="headerlink" href="#default-theme" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>The default theme is called <code>Default</code> and is chosen if no theme has been specified in the <a href="docnetjson.htm">docnet.json</a> file. It is based on the theme from ReadTheDocs, and is created from the one shipped with MkDocs.</p>
-<h2 id="pagetemplate.htm">PageTemplate.htm</h2>
+<h2 id="pagetemplate.htm">PageTemplate.htm<a class="headerlink" href="#pagetemplate.htm" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p>The <code>PageTemplate.htm</code> file is a simple HTML file, located in each <code>theme</code> folder, which is used as the template for all generated <code>.htm</code> files. You can place whatever you like in there, including references to css/js files, headers, footers etc. DocNet however expects a couple of <em>markers</em> which are replaced with the data created from the markdown files. These markers are described below. The markers have to be specified as-is.</p>
 <ul>
 <li><code>{{Name}}</code>. This is replaced with the value specified in <code>Name</code> in the <code>docnet.json</code> file.</li>

usage.htm

@@ -72,7 +72,7 @@
                 </div>
                 <div role="main">
                     <div class="section">
-<h1 id="usage">Usage</h1>
+<h1 id="usage">Usage<a class="headerlink" href="#usage" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h1>
 <p>The usage is simple:</p>
 <p>docnet <em>options</em> <em>folder</em></p>
 <p><em>options</em> can be:</p>
@@ -81,7 +81,7 @@
 </ul>
 <p>By default <code>docnet</code> doesn't remove any file in the destination folder. When specified it will remove all files and folders recursively in the specified <code>Destination</code> folder in the found docnet.json. So use this option with caution, as it won't check whether this is the folder your family photos or precious sourcecode are located! </p>
 <p><em>folder</em> is the folder where a docnet.json file is expected to be present. </p>
-<h2 id="requirements">Requirements</h2>
+<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h2>
 <p><code>Docnet</code> is a .NET full application (using .NET 4.6.1) and requires .NET full to run. Not tested on Mono but it's highly likely it works on Mono without a problem. The code uses .NET 4.6.1 but it can be compiled against lower versions of .NET full, it doesn't use .NET 4.6 specific features but as Microsoft supports only the latest .NET 4.x versions, it was a logical choice to use .NET 4.6.1.</p>
 
                     </div>