youys
/
DocNet
Not watched
1
0
Fork 0
Code
Releases 14 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
Browse Source

Updated docs to match v0.9 features. Implements #13

pull/60/head
Frans Bouma 10 years ago
parent
46e30f5058
commit
343f8517ea
20 changed files with 906 additions and 824 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +3
    -5
      Authoringcontent.htm
  2. +3
    -5
      Configuration.htm
  3. +1
    -1
      MarkdownSource/acknowledgements.md
  4. +1
    -1
      MarkdownSource/docnet.json
  5. +3
    -3
      MarkdownSource/markdownextensions.md
  6. +72
    -3
      MarkdownSource/markdownsupport.md
  7. +3
    -4
      MarkdownSource/themes.md
  8. +5
    -7
      WritingcontentusingMarkdown.htm
  9. +95
    -97
      acknowledgements.htm
  10. +138
    -113
      css/theme.css
  11. +120
    -126
      docnetjson.htm
  12. +1
    -2
      h2leveldiscovery.htm
  13. +96
    -100
      index.htm
  14. +4
    -9
      license.htm
  15. +146
    -182
      markdownextensions.htm
  16. +190
    -125
      markdownsupport.htm
  17. +1
    -3
      search.htm
  18. +5
    -5
      search_index.json
  19. +14
    -21
      themes.htm
  20. +5
    -12
      usage.htm

+ 3
- 5
Authoringcontent.htm View File

@@ -78,14 +78,12 @@
</div>
<div role="main">
<div class="section">
<p><h1>Authoring content</h1></p>

<h1 id="authoring-content">Authoring content</h1>
<p>Please select one of the topic in this section:</p>

<p><ul>
<ul>
<li><a href="themes.htm">Themes</a></li>
<li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li>
</ul></p>
</ul>

</div>
</div>


+ 3
- 5
Configuration.htm View File

@@ -77,14 +77,12 @@
</div>
<div role="main">
<div class="section">
<p><h1>Configuration</h1></p>

<h1 id="configuration">Configuration</h1>
<p>Please select one of the topic in this section:</p>

<p><ul>
<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>
</ul></p>
</ul>

</div>
</div>


+ 1
- 1
MarkdownSource/acknowledgements.md View File

@@ -4,5 +4,5 @@ Acknowledgements
This application wouldn't be possible without the work of others. The (likely incomplete) list below contains the work `Docnet` is based on / builds upon.

* [MkDocs](http://www.mkdocs.org/). `Docnet` borrows a great deal from `MkDocs`: the theme css `Docnet` uses is based on a cleaned up version of their `Readthedocs` theme, as well as the javascript based search is from MkDocs.
* [MarkdownSharp](https://github.com/KyleGobel/MarkdownSharp-GithubCodeBlocks). The markdown parser is an extended version of the `MarkdownSharp` parser from StackExchange with the extensions added by Kyle Gobel.
* [MarkdownDeep](http://www.toptensoftware.com/markdowndeep/). The markdown parser is an extended version of the `MarkdownDeep` parser from topten software.
* [Json.NET](http://www.newtonsoft.com/json). The reading/writing of json files is important for `Docnet` and it uses Json.NET for that.

+ 1
- 1
MarkdownSource/docnet.json View File

@@ -19,7 +19,7 @@
"Writing content using Markdown" :
{
"Markdown support": "markdownsupport.md",
"Markdown extensions" : "markdownextensions.md"
"DocNet Markdown extensions" : "markdownextensions.md"
}
},
"Search" : "search.md",


+ 3
- 3
MarkdownSource/markdownextensions.md View File

@@ -1,7 +1,7 @@
Markdown extensions
===================
DocNet Markdown extensions
==========================

`Docnet` defines the following markdown extensions to make writing
`Docnet` defines the following markdown extensions to make writing documentation easier.

## Alert boxes
To quickly define alert boxes, `Docnet` defines the `@alert` element. Three types of alerts are defined: *danger* (displayed in red), *warning* (displayed in yellow) and *info* or *neutral*, which is displayed in blue. You specify the type of the alert after the `@alert` statement using &#64;alert *name*. Close the `@alert` with `@end`.


+ 72
- 3
MarkdownSource/markdownsupport.md View File

@@ -1,12 +1,79 @@
Markdown support
================

`DocNet` uses markdown files as input. The markdown is parsed with the markdown parser from StackExchange (called '[MarkdownSharp](https://github.com/KyleGobel/MarkdownSharp-GithubCodeBlocks)'). It supports the default markdown statements as well as github style code block markers and specific extensions for writing documentation, which are described below.
`DocNet` uses markdown files as input. The markdown is parsed with the markdown parser from topten software (called '[MarkdownDeep](http://www.toptensoftware.com/markdowndeep/)'). It supports the default markdown statements as well as github style code block markers and specific extensions for writing documentation, which are described below.

##Standard Markdown
The standard markdown syntax as defined by [John Gruber](https://daringfireball.net/projects/markdown/) is supported in full.

##Php Markdown Extra
MarkdownDeep supports [PHP Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). 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 [unit test files](https://github.com/FransBouma/DocNet/tree/master/src/MarkdownDeepTests/testfiles/extramode) for MarkdownDeep in the [DocNet respository at GitHub](https://github.com/FransBouma/DocNet).

A couple of examples are given below

###Footnotes
MarkdownDeep supports Footnotes, which can be added through the following system: To specify a footnote marker, specify `[^1]`, which will result in:[^1]

The actual footnote text is then specified with `[^1]:` following the text of the actual footnote. Click on the superscript `1` link above to go to the footnote rendered at the bottom of this page.

[^1]: And this is the footnote related to the example above.

###Definition lists
To specify simple definition lists, simply do:

```
Item one
: this is the description of item one

Item Two
: this is the text of item 2
```

which results in:

Item one
: this is the description of item one

Item Two
: this is the text of item 2

###Tables
There's basic support for defining tables.

Specifying:
```
Fruit|Color
--|--
Apples|Red
Pears|Green
Bananas|Yellow
Bongo|Bongo... it's a strange color, do you have a minute? It's a bit like the sea, but also a bit like the beach. You know how it is... oh and a bit like the wind too? You see it? Hey! Where're you going?!
```

results in:

Fruit|Color
--|--
Apples|Red
Pears|Green
Bananas|Yellow
Bongo|Bongo... it's a strange color, do you have a minute? It's a bit like the sea, but also a bit like the beach. You know how it is... oh and a bit like the wind too? You see it? Hey! Where're you going?!

###Abbreviations
There's also support for abbreviations, using the `<abbr>` HTML tag.

Specifying:
```
*[FuBar]: F**ked Up Beyond Any Repair.
```
*[FuBar]: F**ked Up Beyond Any Repair.

gives an abbreviation link in the following sentence: This is a test for abbreviations: FuBar.

##Highlighting code
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 [Highlight.js](https://highlightjs.org/) javascript library and most popular languages are included.

Example: to specify a codeblock as C#, append `cs` after the first ` ``` ` marker:
Example: to specify a codeblock as C#, append `cs` after the first ``` marker:

```cs
var i=42;
@@ -19,4 +86,6 @@ this is a simple <pre> block
```

##Linking
`Docnet` 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 `How to\AddEntity.md` from a page. In the result site this should be the link `How%20to/AddEntity.htm`, which you should specify in your markdown. In the future it might be `docnet` 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 `%20`.
`Docnet` 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 `How to\AddEntity.md` from a page. In the result site this should be the link `How%20to/AddEntity.htm`, which you should specify in your markdown. In the future it might be `docnet` 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 `%20`.



+ 3
- 4
MarkdownSource/themes.md View File

@@ -20,8 +20,7 @@ The `PageTemplate.htm` file is a simple HTML file, located in each `theme` folde
* `{{Breadcrumbs}}`. This is replaced with a / delimited list of names making up the bread crumbs representing the navigation through the ToC to reach the current page.
* `{{ExtraScript}}`. This is replaced with extra script definitions / references required by some pages, like the search page. It's `docnet` specific and if this marker isn't present, search won't work.
* `{{Path}}`. This is used to fill in the relative path to reach css/js files in hard-coded URLs in the `PageTemplate` file. This means that specifying a css URL in `PageTemplate` should look like:

```HTML
<link rel="stylesheet" href="{{Path}}css/theme.css" type="text/css" />
```
```HTML
<link rel="stylesheet" href="{{Path}}css/theme.css" type="text/css" />
```
`Docnet` will then replace `{{Path}}` with e.g. '../../' to get to the css file from the location of the .htm file loaded.

+ 5
- 7
WritingcontentusingMarkdown.htm View File

@@ -46,7 +46,7 @@
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span></li>
<li class="tocentry"><a href="markdownsupport.htm">Markdown support</a>
</li>
<li class="tocentry"><a href="markdownextensions.htm">Markdown extensions</a>
<li class="tocentry"><a href="markdownextensions.htm">DocNet Markdown extensions</a>
</li>

</ul>
@@ -85,14 +85,12 @@
</div>
<div role="main">
<div class="section">
<p><h1>Writing content using Markdown</h1></p>

<h1 id="writing-content-using-markdown">Writing content using Markdown</h1>
<p>Please select one of the topic in this section:</p>

<p><ul>
<ul>
<li><a href="markdownsupport.htm">Markdown support</a></li>
<li><a href="markdownextensions.htm">Markdown extensions</a></li>
</ul></p>
<li><a href="markdownextensions.htm">DocNet Markdown extensions</a></li>
</ul>

</div>
</div>


+ 95
- 97
acknowledgements.htm View File

@@ -1,100 +1,98 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Acknowledgements - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>

<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry current"><a class="current" href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="acknowledgements.htm">Acknowledgements</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<p><h1>Acknowledgements</h1></p>

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Acknowledgements - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>
<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry current"><a class="current" href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="acknowledgements.htm">Acknowledgements</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<h1 id="acknowledgements">Acknowledgements</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/">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>
<li><a href="https://github.com/KyleGobel/MarkdownSharp-GithubCodeBlocks">MarkdownSharp</a>. The markdown parser is an extended version of the <code>MarkdownSharp</code> parser from StackExchange with the extensions added by Kyle Gobel. </li>
<li><a href="http://www.newtonsoft.com/json">Json.NET</a>. The reading/writing of json files is important for <code>Docnet</code> and it uses Json.NET for that. </li>
<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>
<li><a href="http://www.toptensoftware.com/markdowndeep/" target="_blank">MarkdownDeep</a>. The markdown parser is an extended version of the <code>MarkdownDeep</code> parser from topten software. </li>
<li><a href="http://www.newtonsoft.com/json" target="_blank">Json.NET</a>. The reading/writing of json files is important for <code>Docnet</code> and it uses Json.NET for that. </li>
</ul>
</div>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>
</div>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>

+ 138
- 113
css/theme.css View File

@@ -127,14 +127,14 @@ a {
text-decoration: none;
}

a .icon {
display: inline-block;
text-decoration: inherit;
}
a .icon {
display: inline-block;
text-decoration: inherit;
}

a:hover, a:active {
outline: 0;
}
a:hover, a:active {
outline: 0;
}

abbr[title] {
border-bottom: 1px dotted;
@@ -152,18 +152,18 @@ blockquote {
quotes: "\201C""\201D""\2018""\2019";
}

blockquote:before {
color: #ccc;
content: open-quote;
font-size: 4em;
line-height: 0.1em;
margin-right: 10px;
vertical-align: -0.4em;
}
blockquote:before {
color: #ccc;
content: open-quote;
font-size: 4em;
line-height: 0.1em;
margin-right: 10px;
vertical-align: -0.4em;
}

blockquote p {
display: inline;
}
blockquote p {
display: inline;
}


body {
@@ -186,14 +186,14 @@ button, input {
*vertical-align: middle;
}

button[disabled], input[disabled] {
cursor: default;
}
button[disabled], input[disabled] {
cursor: default;
}

button::-moz-focus-inner, input::-moz-focus-inner {
border: 0;
padding: 0;
}
button::-moz-focus-inner, input::-moz-focus-inner {
border: 0;
padding: 0;
}

button {
font-size: 100%;
@@ -216,18 +216,35 @@ code, pre.nocode {
overflow-x: auto;
}

code.code-large {
font-size: 90%;
}

dd {
margin: 0;
code.code-large {
font-size: 90%;
}

dfn {
font-style: italic;
}

dl {
margin-bottom: 24px;
}

dl dt {
font-weight: bold;
}

dl p, dl table, dl ul, dl ol {
margin-bottom: 12px !important;
}

dl dd {
margin: 0 0 12px 24px;
}

dl:not(.docutils) {
margin-bottom: 24px;
}


figure {
margin: 0;
}
@@ -249,35 +266,40 @@ form {
h1, h2, h3, h4, h5, h6 {
margin-top: 0;
font-weight: lighter;
margin-bottom: -10px;
}

h1 {
font-size: 220%;
margin-bottom:25px;
}

h2 {
font-size: 190%;
margin-bottom:18px;
}

h3 {
font-size: 155%;
margin-bottom:15px;
}

h4 {
font-size: 130%;
margin-bottom: 13px;
}

h4.searchresulttitle {
margin-bottom: -5px;
}
h4.searchresulttitle {
margin-bottom: -5px;
}

h5 {
font-size: 115%;
margin-bottom: 10px;
}

h6 {
font-size: 105%;
margin-bottom: 7px;
}

hr {
@@ -312,23 +334,23 @@ input {
*vertical-align: middle;
}

input[type="text"] {
-webkit-appearance: none;
padding: 6px;
display: inline-block;
border: 1px solid;
font-size: 80%;
box-shadow: inset 0 1px 3px #ddd;
border-radius: 0;
-webkit-transition: border 0.3s linear;
-moz-transition: border 0.3s linear;
transition: border 0.3s linear;
}
input[type="text"] {
-webkit-appearance: none;
padding: 6px;
display: inline-block;
border: 1px solid;
font-size: 80%;
box-shadow: inset 0 1px 3px #ddd;
border-radius: 0;
-webkit-transition: border 0.3s linear;
-moz-transition: border 0.3s linear;
transition: border 0.3s linear;
}

/* For chrome, to avoid ugly bar around search box*/
input:focus {
outline: none;
}
/* For chrome, to avoid ugly bar around search box*/
input:focus {
outline: none;
}

ins {
text-decoration: none;
@@ -491,17 +513,21 @@ td {
text-align: center;
}

.toc-footer hr {
width: 100%;
display: block;
height: 1px;
border: 0;
border-top: 1px solid;
margin-left: auto;
margin-right: auto;
padding-bottom: 0;
margin-bottom: 5px;
}
.toc-footer hr {
width: 100%;
display: block;
height: 1px;
border: 0;
border-top: 1px solid;
margin-left: auto;
margin-right: auto;
padding-bottom: 0;
margin-bottom: 5px;
}

.footnotes {
font-size:smaller;
}

/* #endregion */

@@ -533,52 +559,51 @@ td {
margin-bottom: 24px;
}

.table caption {
font-size: 85%;
font-style: italic;
padding: 1em 0;
text-align: center;
}
.table caption {
font-size: 85%;
font-style: italic;
padding: 1em 0;
text-align: center;
}

.table td, .table th {
font-size: 90%;
margin: 0;
overflow: visible;
padding: 8px 16px;
}
.table td, .table th {
font-size: 90%;
margin: 0;
overflow: visible;
padding: 8px 16px;
}

.table td:first-child, .table th:first-child {
border-left-width: 0;
}
.table td:first-child, .table th:first-child {
border-left-width: 0;
}

.table thead {
text-align: left;
vertical-align: bottom;
white-space: nowrap;
}
.table thead {
text-align: left;
vertical-align: bottom;
white-space: nowrap;
}

.table thead th {
font-weight: bold;
border-bottom: solid 2px;
}
.table thead th {
font-weight: bold;
border-bottom: solid 2px;
}

.table td {
background-color: transparent;
vertical-align: middle;
}
.table td {
background-color: transparent;
}

.table td p {
line-height: 18px;
}
.table td p {
line-height: 18px;
}

.table td p:last-child {
margin-bottom: 0;
}
.table td p:last-child {
margin-bottom: 0;
}

.table .table-cell-min {
width: 1%;
padding-right: 0;
}
.table .table-cell-min {
width: 1%;
padding-right: 0;
}

.table-secondary {
font-size: 90%;
@@ -592,14 +617,14 @@ td {
border: 1px solid;
}

.table-bordered-all td {
border-bottom: 1px solid;
border-left: 1px solid;
}
.table-bordered-all td {
border-bottom: 1px solid;
border-left: 1px solid;
}

.table-bordered-all tbody > tr:last-child td {
border-bottom-width: 0;
}
.table-bordered-all tbody > tr:last-child td {
border-bottom-width: 0;
}

.table-bordered {
border: 1px solid;
@@ -632,13 +657,13 @@ td {
overflow: auto;
}

.table-responsive table {
margin-bottom: 0 !important;
}
.table-responsive table {
margin-bottom: 0 !important;
}

.table-responsive table td, .table-responsive table th {
white-space: nowrap;
}
.table-responsive table td, .table-responsive table th {
white-space: nowrap;
}
/* #endregion*/

/* #region Tabs*/


+ 120
- 126
docnetjson.htm View File

@@ -1,112 +1,109 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Site configuration with the docnet.json file - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>

<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Configuration.htm">Configuration</a></span></li>
<li class="tocentry current"><a class="current" href="docnetjson.htm">Site configuration with the docnet.json file</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#Levelswithout__indexdefined">Levels without __index defined</a></li>
</ul>
<li class="tocentry"><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a>
</li>

</ul>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Configuration.htm">Configuration</a></li> / <li><a href="docnetjson.htm">Site configuration with the docnet.json file</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<p><h1>The configuration file: 'docnet.json'</h1></p>

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Site configuration with the docnet.json file - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>
<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Configuration.htm">Configuration</a></span></li>
<li class="tocentry current"><a class="current" href="docnetjson.htm">Site configuration with the docnet.json file</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#levels-without-index-defined">Levels without __index defined</a></li>
</ul>
<li class="tocentry"><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a>
</li>
</ul>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Configuration.htm">Configuration</a></li> / <li><a href="docnetjson.htm">Site configuration with the docnet.json file</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<h1 id="the-configuration-file-docnet.json">The configuration file: 'docnet.json'</h1>
<p>DocNet uses a json file to determine what to do in what form. The format is straight forward and described below</p>

<p><pre><code class="json">{
"Name" : "name of site",
"Source" : "sourcefolder",
"Destination" : "destinationfolder",
"Theme" : "themefolder",
"SourceFoldersToCopy" : ["folder1", "foldern"],
"Footer" : "footer text or HTML",
"Pages" :
<pre><code class="json">{
&quot;Name&quot; : &quot;name of site&quot;,
&quot;Source&quot; : &quot;sourcefolder&quot;,
&quot;Destination&quot; : &quot;destinationfolder&quot;,
&quot;Theme&quot; : &quot;themefolder&quot;,
&quot;SourceFoldersToCopy&quot; : [&quot;folder1&quot;, &quot;foldern&quot;],
&quot;Footer&quot; : &quot;footer text or HTML&quot;,
&quot;Pages&quot; :
{
"__index" : "index.md",
"Title Page 1": "filename_page1.md",
"Title Page 2": "filename_page2.md",
"Sub Header 1":
&quot;__index&quot; : &quot;index.md&quot;,
&quot;Title Page 1&quot;: &quot;filename_page1.md&quot;,
&quot;Title Page 2&quot;: &quot;filename_page2.md&quot;,
&quot;Sub Header 1&quot;:
{
"__index" : "index.md",
"Title Page 3" : "filename_page3.md",
"Title Page 4" : "filename_page4.md"
&quot;__index&quot; : &quot;index.md&quot;,
&quot;Title Page 3&quot; : &quot;filename_page3.md&quot;,
&quot;Title Page 4&quot; : &quot;filename_page4.md&quot;
}
}
}
</code></pre></p>
</code></pre>

<p>The order in which the pages are specified is the order in which they'll appear in the navigation. </p>

<ul>
<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>
@@ -116,29 +113,26 @@
<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>
<li><code>Pages</code> contains the pages to generate into the output, in the order and structure in which you want them to appear in the navigation. The name given is the value used in the navigation tree and has to be unique per level. The value specified with each name is the markdown file to load, parse and generate as .htm file in the output. The markdown file is relative to the path specified in <code>Source</code>. A file <code>foo.md</code> will be generated as <code>foo.htm</code> in the output. </li>
</ul>
Paths are expected to use `\` characters, and as it's json, you have to escape them, so the path `.\foo` becomes `.\\foo`.

<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>

<p><a name="Levelswithout__indexdefined"></a><h2>Levels without __index defined</h2></p>

<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>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>
<h2 id="levels-without-index-defined">Levels without __index defined</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>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>

+ 1
- 2
h2leveldiscovery.htm View File

@@ -77,8 +77,7 @@
</div>
<div role="main">
<div class="section">
<p><h1>Automatic H2 level ToC entry discovery</h1></p>

<h1 id="automatic-h2-level-toc-entry-discovery">Automatic H2 level ToC entry discovery</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>


+ 96
- 100
index.htm View File

@@ -1,100 +1,96 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Home - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>

<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<p><h1>DocNet</h1></p>

<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 source of this site, look at the <a href="https://github.com/FransBouma/DocNet/tree/gh-pages">gh-pages branch in the DocNet repository at <i class="fa fa-github"></i> GitHub</a>.</p>

<p><a name="GetDocNet"></a><h2>Get DocNet</h2></p>

<p>To get <code>DocNet</code>, either build it from source using the <a href="https://github.com/FransBouma/DocNet"><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">'Releases' section of the github repository</a></p>

</div>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Home - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>
<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<h1 id="docnet">DocNet</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 source of this site, look at 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>
<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>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>

+ 4
- 9
license.htm View File

@@ -70,20 +70,15 @@
</div>
<div role="main">
<div class="section">
<p><h1>License</h1></p>

<h1 id="license">License</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>

<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>

<p><ul>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<ul>
<li>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</li>
</ul>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>

</div>
</div>


+ 146
- 182
markdownextensions.htm View File

@@ -1,190 +1,154 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Markdown extensions - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>

<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Authoringcontent.htm">Authoring content</a></span></li>
<li class="tocentry"><a href="themes.htm">Themes</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span></li>
<li class="tocentry"><a href="markdownsupport.htm">Markdown support</a>
</li>
<li class="tocentry current"><a class="current" href="markdownextensions.htm">Markdown extensions</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#Alertboxes">Alert boxes</a></li>
<li class="tocentry"><a href="#FontAwesomeicons">Font Awesome icons</a></li>
<li class="tocentry"><a href="#Tabs">Tabs</a></li>
</ul>

</ul>
</li>

</ul>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Authoringcontent.htm">Authoring content</a></li> / <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> / <li><a href="markdownextensions.htm">Markdown extensions</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<p><h1>Markdown extensions</h1></p>

<p><code>Docnet</code> defines the following markdown extensions to make writing </p>

<p><a name="Alertboxes"></a><h2>Alert boxes</h2></p>

<p>To quickly define alert boxes, <code>Docnet</code> defines the <code>&#64;alert</code> element. Three types of alerts are defined: <em>danger</em> (displayed in red), <em>warning</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>&#64;alert</code> statement using &#64;alert <em>name</em>. Close the <code>&#64;alert</code> with <code>&#64;end</code>. </p>

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DocNet Markdown extensions - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>
<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Authoringcontent.htm">Authoring content</a></span></li>
<li class="tocentry"><a href="themes.htm">Themes</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span></li>
<li class="tocentry"><a href="markdownsupport.htm">Markdown support</a>
</li>
<li class="tocentry current"><a class="current" href="markdownextensions.htm">DocNet Markdown extensions</a>
<ul class="currentrelative">
<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>
</ul>
</ul>
</li>
</ul>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Authoringcontent.htm">Authoring content</a></li> / <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> / <li><a href="markdownextensions.htm">DocNet Markdown extensions</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<h1 id="docnet-markdown-extensions">DocNet Markdown extensions</h1>
<p><code>Docnet</code> defines the following markdown extensions to make writing documentation easier. </p>
<h2 id="alert-boxes">Alert boxes</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> (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>

<p><pre class="nocode">&#64;alert danger
<pre class="nocode">@alert danger
This is a dangerous text, it will be displayed in a danger alert box!
&#64;end
</pre></p>

<p>results in</p>

<p>

<div class="alert alert-danger"><span class="alert-title"><i class="fa fa-times-circle"></i> Danger!</span>This is a dangerous text, it will be displayed in a danger alert box!</div></p>

<p>The markdown: </p>

<p><pre class="nocode">&#64;alert warning
@end
</pre><p>results in</p>
<div class="alert alert-danger"><span class="alert-title"><i class="fa fa-times-circle"></i> Danger!</span><p>This is a dangerous text, it will be displayed in a danger alert box!</p>
</div><p>The markdown: </p>
<pre class="nocode">@alert warning
This is a warning text, it will be displayed in a warning alert box!
&#64;end
</pre></p>

<p>results in</p>

<p>

<div class="alert alert-warning"><span class="alert-title"><i class="fa fa-warning"></i> Warning!</span>This is a warning text, it will be displayed in a warning alert box!</div></p>

<p>The markdown: </p>

<p><pre class="nocode">&#64;alert info
@end
</pre><p>results in</p>
<div class="alert alert-warning"><span class="alert-title"><i class="fa fa-warning"></i> Warning!</span><p>This is a warning text, it will be displayed in a warning alert box!</p>
</div><p>The markdown: </p>
<pre class="nocode">@alert info
This is an info text, it will be displayed in an info alert box!
&#64;end
</pre></p>

<p>Results in</p>

<p>

<div class="alert alert-info"><span class="alert-title"><i class="fa fa-info-circle"></i> Info</span>This is an info text, it will be displayed in an info alert box!</div></p>

<p><a name="FontAwesomeicons"></a><h2>Font Awesome icons</h2></p>

<p>To specify a font-awesome icon, use <code>&#64;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>&#64;fa-github</code>, which will result in: <i class="fa fa-github"></i> </p>

<p><a name="Tabs"></a><h2>Tabs</h2></p>

<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">Joseph Fusco</a>.</p>

<p>To start a Tab control, start with <code>&#64;tabs</code> and end the tabs definition with <code>&#64;endtabs</code>. Between those two statements, which each need to be suffixed with a newline, you define one or more tabs using <code>&#64;tab</code> followed by the label text for that tab, followed by a newline. End your tab contents with <code>&#64;end</code>.</p>

@end
</pre><p>Results in</p>
<div class="alert alert-info"><span class="alert-title"><i class="fa fa-info-circle"></i> Info</span><p>This is an info text, it will be displayed in an info alert box!</p>
</div><h2 id="font-awesome-icons">Font Awesome icons</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>
<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>
<pre class="nocode">@tabs
@tab First Tab
This is the text for the first tab. It's nothing special

<p><pre class="nocode">&#64;tabs
&#64;tab First Tab
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.
&#64;end
&#64;tab Second Tab
As you can see, it can deal with newlines as well.
@end
@tab Second Tab
Now, the second tab however is very interesting. At least let's pretend it is!
&#64;end
&#64;endtabs
</pre></p>

<p>will result in: </p>

<p><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">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. </div><div class="tab-content">Now, the second tab however is very interesting. At least let's pretend it is!</div></div></p>

</div>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>
@end
@endtabs
</pre><p>will result in: </p>
<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>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>

+ 190
- 125
markdownsupport.htm View File

@@ -1,130 +1,195 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Markdown support - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>
<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Authoringcontent.htm">Authoring content</a></span></li>
<li class="tocentry"><a href="themes.htm">Themes</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span></li>
<li class="tocentry current"><a class="current" href="markdownsupport.htm">Markdown support</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#standard-markdown">Standard Markdown</a></li>
<li class="tocentry"><a href="#php-markdown-extra">Php Markdown Extra</a></li>
<li class="tocentry"><a href="#highlighting-code">Highlighting code</a></li>
<li class="tocentry"><a href="#linking">Linking</a></li>
</ul>
<li class="tocentry"><a href="markdownextensions.htm">DocNet Markdown extensions</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Authoringcontent.htm">Authoring content</a></li> / <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> / <li><a href="markdownsupport.htm">Markdown support</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<h1 id="markdown-support">Markdown support</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>
<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>
<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>
<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>
<p>To specify simple definition lists, simply do:</p>
<pre class="nocode">Item one
: this is the description of item one

<title>Markdown support - DocNet Documentation</title>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="css/theme.css" type="text/css" />
<link rel="stylesheet" href="css/theme_colors.css" type="text/css" />
<link rel="stylesheet" href="css/styles/vs.css">
<link rel="stylesheet" href="css/font-awesome.4.5.0.min.css">
</head>
<body role="document">
<div class="grid-for-nav">
<nav data-toggle="nav-shift" class="nav-side stickynav">
<div class="side-nav-search">
<a href="index.htm"><i class="fa fa-home"></i> DocNet Documentation</a>
<div role="search">
<form id="search-form" class="form" action="Docnet_search.htm" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="menu menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="tocentry"><a href="index.htm">Home</a>
</li>

<li class="tocentry"><a href="usage.htm">Usage</a>
</li>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Authoringcontent.htm">Authoring content</a></span></li>
<li class="tocentry"><a href="themes.htm">Themes</a>
</li>
<li class="tocentry">
<ul>
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span></li>
<li class="tocentry current"><a class="current" href="markdownsupport.htm">Markdown support</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#Highlightingcode">Highlighting code</a></li>
<li class="tocentry"><a href="#Linking">Linking</a></li>
</ul>
<li class="tocentry"><a href="markdownextensions.htm">Markdown extensions</a>
</li>

</ul>
</li>

</ul>
</li>
<li class="tocentry"><a href="search.htm">Search</a>
</li>
<li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a>
</li>
<li class="tocentry"><a href="license.htm">License</a>
</li>
</ul>
<div class="toc-footer">
<span class="text-small">
<hr/>
<a href="https://github.com/FransBouma/DocNet" target="_blank">Made with <i class="fa fa-github"></i> DocNet</a>
</span>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="nav-shift" class="nav-content-wrap">
<nav class="nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="nav-top" class="fa fa-bars"></i>
<a href="index.htm">DocNet Documentation</a>
</nav>
<div class="nav-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="breadcrumbs">
<ul><li><a href="index.htm">Home</a></li> / <li><a href="Authoringcontent.htm">Authoring content</a></li> / <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> / <li><a href="markdownsupport.htm">Markdown support</a></li></ul>
</div>
<hr />
</div>
<div role="main">
<div class="section">
<p><h1>Markdown support</h1></p>

<p><code>DocNet</code> uses markdown files as input. The markdown is parsed with the markdown parser from StackExchange (called '<a href="https://github.com/KyleGobel/MarkdownSharp-GithubCodeBlocks">MarkdownSharp</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>

<p><a name="Highlightingcode"></a><h2>Highlighting code</h2></p>

<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/">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 <code>```</code> marker:</p>

<p><pre><code class="cs">var i=42;
</code></pre></p>
Item Two
: this is the text of item 2
</pre><p>which results in: </p>
<dl>
<dt>Item one</dt>
<dd>this is the description of item one</dd>
<dt>Item Two</dt>
<dd>this is the text of item 2</dd>
</dl>
<h3 id="tables">Tables</h3>
<p>There's basic support for defining tables. </p>
<p>Specifying: </p>
<pre class="nocode">Fruit|Color
--|--
Apples|Red
Pears|Green
Bananas|Yellow
Bongo|Bongo... it's a strange color, do you have a minute? It's a bit like the sea, but also a bit like the beach. You know how it is... oh and a bit like the wind too? You see it? Hey! Where're you going?!
</pre><p>results in:</p>
<table class="table table-bordered-all table-responsive">
<thead>
<tr>
<th>Fruit</th>
<th>Color</th>
</tr>
</thead>
<tbody>
<tr>
<td>Apples</td>
<td>Red</td>
</tr>
<tr>
<td>Pears</td>
<td>Green</td>
</tr>
<tr>
<td>Bananas</td>
<td>Yellow</td>
</tr>
<tr>
<td>Bongo</td>
<td>Bongo... it's a strange color, do you have a minute? It's a bit like the sea, but also a bit like the beach. You know how it is... oh and a bit like the wind too? You see it? Hey! Where're you going?!</td>
</tr>
</tbody>
</table>
<h3 id="abbreviations">Abbreviations</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>
<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;
</code></pre>

<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>

<p><pre class="nocode">this is a simple &lt;pre&gt; block
</pre></p>

<p><a name="Linking"></a><h2>Linking</h2></p>

<pre class="nocode">this is a simple &lt;pre&gt; block
</pre><h2 id="linking">Linking</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>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1">
<p>And this is the footnote related to the example above.&nbsp;<a href="#fnref:1" rev="footnote">&#8617;</a></p>
</li>
</ol>
</div>
</div>
</div>
<footer>
<hr />
<div role="contentinfo">
Made with DocNet. Get your copy at: <a href='https://github.com/FransBouma/DocNet' target='_blank'>https://github.com/FransBouma/DocNet</a>.
</div>
</footer>
</div>
</section>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="js/modernizr-2.8.3.min.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/theme.js"></script>
{{ExtraScript}}
</body>
</html>

+ 1
- 3
search.htm View File

@@ -70,10 +70,8 @@
</div>
<div role="main">
<div class="section">
<p><h1>Search</h1></p>

<h1 id="search">Search</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>

</div>


+ 5
- 5
search_index.json View File

@@ -27,14 +27,14 @@
{
"location": "markdownsupport.htm",
"breadcrumbs": "Home / Authoring content / Writing content using Markdown / Markdown support",
"keywords": "20 20to 42 a AddEntity after allow also and any append are as at based be beautifying been below besides block but C called code codeblock com convert cs default described destination docnet Docnet DocNet document documentation doesn easy escape Example extended extensions feature file files first fixed folder font for from future get github GitHub GithubCodeBlocks has Highlight highlighting Highlighting highlightjs How htm https i If in In included input is it It javascript js KyleGobel language languages library link Linking links markdown Markdown MarkdownSharp marker markers md means might moment most name need nohighlight not of on ones org page parsed parser popular pre present result should simple site sized so space spaces specific specifications specify StackExchange statements style support supports text that the The this This to To transform transformation updated url urls use uses usual var want well which will with writing you your",
"keywords": "1 2 20 20to 42 a A abbr abbreviation abbreviations Abbreviations above actual added AddEntity Additionally after all allow also an and And any Any append Apples are as at Bananas based basic be beach beautifying been below besides Beyond bit block Bongo bottom but by C ca called can Click code codeblock color Color com comes convert couple cs daringfireball default define defined defining definition Definition described description destination do docnet Docnet DocNet document documentation doesn e easy escape example Example examples extended extensions extra Extra extramode F feature file files first fixed folder following font footnote footnotes Footnotes for FransBouma from Fruit FuBar full future g get github GitHub given gives go going Green Gruber has have Hey Highlight highlighting Highlighting highlightjs how How htm HTML http https i If in In included input is it It item Item javascript John js ked know language languages library like link Linking links lists look markdown Markdown markdowndeep MarkdownDeep MarkdownDeepTests marker markers master md means michelf might minute moment more most name neat need net nohighlight not of oh on one ones org page parsed parser Pears php Php PHP Please popular pre present projects Red related rendered Repair respository result results sea see sentence set should simple simply site sized so software space spaces specific specifications specified specify Specifying src standard Standard statements strange style superscript support supported supports syntax system tables Tables tag test testfiles text that the The then There this This through to To too topten toptensoftware transform transformation tree Two unit Up updated url urls use uses using usual var want well Where which will wind with writing www Yellow you You your",
"title": "Markdown support"
},
{
"location": "markdownextensions.htm",
"breadcrumbs": "Home / Authoring content / Writing content using Markdown / 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 each 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 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 to To two type types use used using very warning well where which will with work writing Wvzjrm yellow you You your",
"title": "Markdown extensions"
"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 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 to To two type types use used using very warning well where which will with work writing Wvzjrm yellow you You your",
"title": "DocNet Markdown extensions"
},
{
"location": "search.htm",
@@ -45,7 +45,7 @@
{
"location": "acknowledgements.htm",
"breadcrumbs": "Home / Acknowledgements",
"keywords": "a Acknowledgements added an and application as based be below borrows builds by cleaned com contains css deal Docnet extended extensions files for from github GithubCodeBlocks Gobel great http https important incomplete is it javascript json Json Kyle KyleGobel likely list markdown MarkdownSharp mkdocs MkDocs NET newtonsoft of on org others parser possible reading Readthedocs search StackExchange that the The their theme This up upon uses version well with without work wouldn writing www",
"keywords": "a Acknowledgements an and application as based be below borrows builds cleaned com contains css deal Docnet extended files for from great http important incomplete is it javascript json Json likely list markdown markdowndeep MarkdownDeep mkdocs MkDocs NET newtonsoft of on org others parser possible reading Readthedocs search software that the The their theme This topten toptensoftware up upon uses version well without work wouldn writing www",
"title": "Acknowledgements"
},
{


+ 14
- 21
themes.htm View File

@@ -41,9 +41,9 @@
<li><span class="navigationgroup"><i class="fa fa-caret-down"></i> <a href="Authoringcontent.htm">Authoring content</a></span></li>
<li class="tocentry current"><a class="current" href="themes.htm">Themes</a>
<ul class="currentrelative">
<li class="tocentry"><a href="#Themesfolder">Themes folder</a></li>
<li class="tocentry"><a href="#Defaulttheme">Default theme</a></li>
<li class="tocentry"><a href="#PageTemplatehtm">PageTemplate.htm</a></li>
<li class="tocentry"><a href="#themes-folder">Themes folder</a></li>
<li class="tocentry"><a href="#default-theme">Default theme</a></li>
<li class="tocentry"><a href="#pagetemplate.htm">PageTemplate.htm</a></li>
</ul>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span>
@@ -82,22 +82,14 @@
</div>
<div role="main">
<div class="section">
<p><h1>Themes</h1></p>

<h1 id="themes">Themes</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>

<p><a name="Themesfolder"></a><h2>Themes folder</h2></p>

<h2 id="themes-folder">Themes folder</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>

<p><a name="Defaulttheme"></a><h2>Default theme</h2></p>

<h2 id="default-theme">Default theme</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>

<p><a name="PageTemplatehtm"></a><h2>PageTemplate.htm</h2></p>

<h2 id="pagetemplate.htm">PageTemplate.htm</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>
<li><code>{{Content}}</code>. This is replaced with the HTML generated from the markdown file. </li>
@@ -106,13 +98,14 @@
<li><code>{{Footer}}</code>. This is replaced with the value specified in <code>Footer</code> in the docnet.json file. </li>
<li><code>{{Breadcrumbs}}</code>. This is replaced with a / delimited list of names making up the bread crumbs representing the navigation through the ToC to reach the current page. </li>
<li><code>{{ExtraScript}}</code>. This is replaced with extra script definitions / references required by some pages, like the search page. It's <code>docnet</code> specific and if this marker isn't present, search won't work.</li>
<li><code>{{Path}}</code>. This is used to fill in the relative path to reach css/js files in hard-coded URLs in the <code>PageTemplate</code> file. This means that specifying a css URL in <code>PageTemplate</code> should look like:</li>
</ul>
<li>
<code>{{Path}}</code>. This is used to fill in the relative path to reach css/js files in hard-coded URLs in the <code>PageTemplate</code> file. This means that specifying a css URL in <code>PageTemplate</code> should look like:
<pre><code class="HTML">&lt;link rel=&quot;stylesheet&quot; href=&quot;{{Path}}css/theme.css&quot; type=&quot;text/css&quot; /&gt;
</code></pre>

<p><pre><code class="HTML">&lt;link rel="stylesheet" href="{{Path}}css/theme.css" type="text/css" /&gt;
</code></pre></p>

<p><code>Docnet</code> will then replace <code>{{Path}}</code> with e.g. '../../' to get to the css file from the location of the .htm file loaded.</p>
<code>Docnet</code> will then replace <code>{{Path}}</code> with e.g. '../../' to get to the css file from the location of the .htm file loaded.
</li>
</ul>

</div>
</div>


+ 5
- 12
usage.htm View File

@@ -33,7 +33,7 @@

<li class="tocentry current"><a class="current" href="usage.htm">Usage</a>
<ul class="currentrelativeroot">
<li class="tocentry"><a href="#Requirements">Requirements</a></li>
<li class="tocentry"><a href="#requirements">Requirements</a></li>
</ul>
<li class="tocentry">
<span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Configuration.htm">Configuration</a></span>
@@ -72,23 +72,16 @@
</div>
<div role="main">
<div class="section">
<p><h1>Usage</h1></p>

<h1 id="usage">Usage</h1>
<p>The usage is simple:</p>

<p>docnet <em>options</em> <em>folder</em></p>

<p><em>options</em> can be:</p>

<p><ul>
<ul>
<li>-c : clear destination folder. </li>
</ul>
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>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>

<p><a name="Requirements"></a><h2>Requirements</h2></p>

<h2 id="requirements">Requirements</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>


Write Preview
Loading…
Cancel
Save