| @@ -79,7 +79,7 @@ | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <h1 id="authoring-content">Authoring content</h1> | |||
| <p>Please select one of the topic in this section:</p> | |||
| <p>Please select one of the topics in this section:</p> | |||
| <ul> | |||
| <li><a href="themes.htm">Themes</a></li> | |||
| <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> | |||
| @@ -78,7 +78,7 @@ | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <h1 id="configuration">Configuration</h1> | |||
| <p>Please select one of the topic in this section:</p> | |||
| <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> | |||
| <li><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a></li> | |||
| @@ -2,6 +2,7 @@ | |||
| "Name" : "DocNet Documentation", | |||
| "Source" : ".", | |||
| "Destination" : "..\\", | |||
| "IncludeSource": "Includes", | |||
| "Theme" : "Default", | |||
| "Footer" : "Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.", | |||
| "Pages" : | |||
| @@ -8,6 +8,7 @@ DocNet uses a json file to determine what to do in what form. The format is stra | |||
| "Name" : "name of site", | |||
| "Source" : "sourcefolder", | |||
| "Destination" : "destinationfolder", | |||
| "IncludeSource": "includefolder", | |||
| "Theme" : "themefolder", | |||
| "SourceFoldersToCopy" : ["folder1", "foldern"], | |||
| "Footer" : "footer text or HTML", | |||
| @@ -31,6 +32,7 @@ The order in which the pages are specified is the order in which they'll appear | |||
| * `Name` specifies the name of the site to generate. | |||
| * `Source` specifies the root of the tree of folders in which markdown files are expected. `sourcefolder` can be a relative path or an absolute path and is used as the root folder for filenames specified in `Pages`. | |||
| * `Destination` specifies the folder where the output will be written to (.htm files). The output will be written to this folder only, all files from subfolders in `Source` will be written to the folder specified in `Destination`. with the same structure as the *navigation* in `Pages`. `destinationfolder` can be a relative path or an absolute path. | |||
| * `IncludeSource` specifies the folder where the files specified to be included using [@@include directives](markdownextensions.htm#include-files) are located. If `IncludeSource` isn't specified, the value `Includes` is assumed. | |||
| * `Theme` specifies the folder within the `Themes` folder in the folder the `docnet` executable is located which is used as the theme for the pages to generate. `Docnet` expects a file called `PageTemplate.htm` within the specified `Theme` folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If `Theme` isn't specified, `Default` is assumed. | |||
| * `SourceFoldersToCopy`. This is an optional directive with, if specified, one or more folder names relative to `Source`, which contain files to copy to the `Destination` folder. E.g. image files used in the markdown files, located in an `Images` folder can be copied this way to the output folder reliably. All folders specified are copied recursively. | |||
| * `Footer`. This is text and/or HTML which is placed in the footer of each page, using a _marker_ (see below). | |||
| @@ -116,3 +116,18 @@ Now, the second tab however is very interesting. At least let's pretend it is! | |||
| @end | |||
| @endtabs | |||
| ##Include files | |||
| You can include other files in your markdown files using the directive `@@include("filename")`, where `filename` 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 `IncludeSource` in the [docnet.json](docnetjson.htm) file. If no `IncludeSource` directive is | |||
| specified in the [docnet.json](docnetjson.htm) file, the folder `Includes` is assumed. | |||
| The directive `@@include("somehtmlinclude.htm")` | |||
| results in the contents of `somehtmlinclude.htm` being included at the spot where the @@include statement is given, as shown below: | |||
| @@include("includedhtml.htm") | |||
| You can also include markdown, which is then processed with the other markdown as if it's part of it. | |||
| @@include("includedmarkdown.md") | |||
| @@ -86,7 +86,7 @@ | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <h1 id="writing-content-using-markdown">Writing content using Markdown</h1> | |||
| <p>Please select one of the topic in this section:</p> | |||
| <p>Please select one of the topics in this section:</p> | |||
| <ul> | |||
| <li><a href="markdownsupport.htm">Markdown support</a></li> | |||
| <li><a href="markdownextensions.htm">DocNet Markdown extensions</a></li> | |||
| @@ -85,6 +85,7 @@ | |||
| "Name" : "name of site", | |||
| "Source" : "sourcefolder", | |||
| "Destination" : "destinationfolder", | |||
| "IncludeSource": "includefolder", | |||
| "Theme" : "themefolder", | |||
| "SourceFoldersToCopy" : ["folder1", "foldern"], | |||
| "Footer" : "footer text or HTML", | |||
| @@ -108,6 +109,7 @@ | |||
| <li><code>Name</code> specifies the name of the site to generate. </li> | |||
| <li><code>Source</code> specifies the root of the tree of folders in which markdown files are expected. <code>sourcefolder</code> can be a relative path or an absolute path and is used as the root folder for filenames specified in <code>Pages</code>. </li> | |||
| <li><code>Destination</code> specifies the folder where the output will be written to (.htm files). The output will be written to this folder only, all files from subfolders in <code>Source</code> will be written to the folder specified in <code>Destination</code>. with the same structure as the <em>navigation</em> in <code>Pages</code>. <code>destinationfolder</code> can be a relative path or an absolute path.</li> | |||
| <li><code>IncludeSource</code> specifies the folder where the files specified to be included using <a href="markdownextensions.htm#include-files">@@include directives</a> are located. If <code>IncludeSource</code> isn't specified, the value <code>Includes</code> is assumed. </li> | |||
| <li><code>Theme</code> specifies the folder within the <code>Themes</code> folder in the folder the <code>docnet</code> executable is located which is used as the theme for the pages to generate. <code>Docnet</code> expects a file called <code>PageTemplate.htm</code> within the specified <code>Theme</code> folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If <code>Theme</code> isn't specified, <code>Default</code> is assumed.</li> | |||
| <li><code>SourceFoldersToCopy</code>. This is an optional directive with, if specified, one or more folder names relative to <code>Source</code>, which contain files to copy to the <code>Destination</code> folder. E.g. image files used in the markdown files, located in an <code>Images</code> folder can be copied this way to the output folder reliably. All folders specified are copied recursively.</li> | |||
| <li><code>Footer</code>. This is text and/or HTML which is placed in the footer of each page, using a <em>marker</em> (see below).</li> | |||
| @@ -51,6 +51,7 @@ | |||
| <li class="tocentry"><a href="#alert-boxes">Alert boxes</a></li> | |||
| <li class="tocentry"><a href="#font-awesome-icons">Font Awesome icons</a></li> | |||
| <li class="tocentry"><a href="#tabs">Tabs</a></li> | |||
| <li class="tocentry"><a href="#include-files">Include files</a></li> | |||
| </ul> | |||
| </ul> | |||
| @@ -145,7 +146,16 @@ 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> | |||
| </div></div><h2 id="include-files">Include files</h2> | |||
| <p>You can include other files in your markdown files using the directive <code>@@include("filename")</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> | |||
| <p>The directive <code>@@include("somehtmlinclude.htm")</code></p> | |||
| <p>results in the contents of <code>somehtmlinclude.htm</code> being included at the spot where the @@include statement is given, as shown below:</p> | |||
| <p><i>This</i> is an <b>included</b> piece of html</p> | |||
| <p>You can also include markdown, which is then processed with the other markdown as if it's part of it. </p> | |||
| <p><em>This</em> is an included <code>piece</code> of <strong>Markdown</strong>.</p> | |||
| </div> | |||
| </div> | |||
| <footer> | |||
| @@ -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 4 a A above absolute all All always an and appear are as assigned assumed be becomes below but called can case characters clicked configuration contain contains content copied copy couple create default Default defined described Destination destinationfolder determine directive do docnet Docnet DocNet document doesn e E each Each elements entry escape example executable exist exists expected expects file filename_page1 filename_page2 filename_page3 filename_page4 filenames files folder folder1 foldern folders foo footer Footer for form format forward from full g generate generated given guarantees has have header Header Home htm HTML if If image Images in index into is isn it It json later level Levels list load loaded located markdown marker md more name Name nameoflevel names navigated navigation no of one only optional or order output page Page pages Pages PageTemplate parent parse path Paths per placed recursively relative reliably root same see See sensitive shown simply site so Source sourcefolder SourceFoldersToCopy special specified specifies specify starting still straight structure sub Sub subfolders target text the The them theme Theme themefolder Themes there they this This Title to topics topictitle tree unique use used uses using value want way what when where which will with within without wrapper written you", | |||
| "keywords": "__index _marker_ _Sub 1 1_ 2 3 4 a A above absolute all All always an and appear are as assigned assumed be becomes below but called can case characters clicked configuration contain contains content copied copy couple create default Default defined described Destination destinationfolder determine directive directives do docnet Docnet DocNet document doesn e E each Each elements entry escape example executable exist exists expected expects file filename_page1 filename_page2 filename_page3 filename_page4 filenames files folder folder1 foldern folders foo footer Footer for form format forward from full g generate generated given guarantees has have header Header Home htm HTML if If image Images in include included includefolder Includes IncludeSource index into is isn it It json later level Levels list load loaded located markdown markdownextensions marker md more name Name nameoflevel names navigated navigation no of one only optional or order output page Page pages Pages PageTemplate parent parse path Paths per placed recursively relative reliably root same see See sensitive shown simply site so Source sourcefolder SourceFoldersToCopy special specified specifies specify starting still straight structure sub Sub subfolders target text the The them theme Theme themefolder Themes there they this This Title to topics topictitle tree unique use used uses using value want way what when where which will with within without wrapper written you", | |||
| "title": "Site configuration with the docnet.json file" | |||
| }, | |||
| { | |||
| @@ -33,7 +33,7 @@ | |||
| { | |||
| "location": "markdownextensions.htm", | |||
| "breadcrumbs": "Home / Authoring content / Writing content using Markdown / DocNet Markdown extensions", | |||
| "keywords": "_iconname_ 64 a add after alert Alert alerts an and are as As At awesome Awesome based be Below Between blue box boxes by can Close codepen contents control converted create CSS3 danger dangerous deal define defined defines definition displayed Docnet DocNet documentation each easier easy element end End endtabs example Example examples extensions fa first First followed following font Font for fusco Fusco github GitHub however HTML http icon iconname icons important in info interesting into io is it It Joseph label least let make markdown Markdown more name need neutral newline newlines nohighlight nothing Now of on one or pen pretend pure quickly red result results Results second Second see set shows simple special specify start statement statements suffixed tab Tab tabs Tabs text that the The them This those Three tip to To two type types use used using very warning well where which will with work writing Wvzjrm yellow you You your", | |||
| "keywords": "_iconname_ 64 a add after alert Alert alerts also an and are as As assumed at At awesome Awesome based be being below Below Between blue box boxes by can Close codepen contents control converted create CSS3 danger dangerous deal define defined defines definition directive displayed docnet Docnet DocNet docnetjson documentation each easier easy element end End endtabs example Example examples extensions fa file filename files first First folder followed following font Font for from fusco Fusco github GitHub given however htm HTML http icon iconname icons if If important in include Include included includedhtml includedmarkdown Includes IncludeSource info interesting into io is isn it It Joseph json label least let make markdown Markdown md more name need neutral newline newlines no nohighlight nothing Now of on one or other part pen pretend processed pure quickly read recursive red result results Results second Second see set shown shows simple somehtmlinclude special specified specify spot start statement statements suffixed system tab Tab tabs Tabs text that the The them then This those Three tip to To two type types under use used using very warning well where which will with work writing Wvzjrm yellow you You your", | |||
| "title": "DocNet Markdown extensions" | |||
| }, | |||
| { | |||