| @@ -41,11 +41,18 @@ | |||
| <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"><a href="markdownextensions.htm">Writing content using Markdown</a> | |||
| <li class="tocentry"> | |||
| <span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span> | |||
| </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"> | |||
| @@ -77,7 +84,7 @@ | |||
| <p><ul> | |||
| <li><a href="themes.htm">Themes</a></li> | |||
| <li><a href="markdownextensions.htm">Writing content using Markdown</a></li> | |||
| <li><a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></li> | |||
| </ul></p> | |||
| </div> | |||
| @@ -46,6 +46,12 @@ | |||
| <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"> | |||
| @@ -39,6 +39,12 @@ | |||
| <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"> | |||
| @@ -0,0 +1,8 @@ | |||
| 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. | |||
| * [Json.NET](http://www.newtonsoft.com/json). The reading/writing of json files is important for `Docnet` and it uses Json.NET for that. | |||
| @@ -16,7 +16,14 @@ | |||
| "Authoring content" : | |||
| { | |||
| "Themes" : "themes.md", | |||
| "Writing content using Markdown" : "markdownextensions.md" | |||
| } | |||
| "Writing content using Markdown" : | |||
| { | |||
| "Markdown support": "markdownsupport.md", | |||
| "Markdown extensions" : "markdownextensions.md" | |||
| } | |||
| }, | |||
| "Search" : "search.md", | |||
| "Acknowledgements" : "acknowledgements.md", | |||
| "License": "license.md" | |||
| } | |||
| } | |||
| @@ -3,3 +3,7 @@ | |||
| DocNet is a simple static documentation generator, 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. | |||
| To see the source of this site, look at the `gh-pages` branch in the [DocNet repository at @fa-github GitHub](https://github.com/FransBouma/DocNet) | |||
| ## Get DocNet | |||
| To get `DocNet`, either build it from source using the [@fa-github github repository](https://github.com/FransBouma/DocNet), or download a pre-build binary package from the ['Releases' section of the github repository](https://github.com/FransBouma/DocNet/releases) | |||
| @@ -0,0 +1,13 @@ | |||
| License | |||
| ======= | |||
| `DocNet` is licensed under the following license: | |||
| The MIT License (MIT) | |||
| Copyright (c) 2016 Frans Bouma | |||
| 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: | |||
| * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |||
| 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. | |||
| @@ -1,26 +1,22 @@ | |||
| Writing content using Markdown | |||
| ============================== | |||
| `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. | |||
| ##Markdown extensions | |||
| Markdown extensions | |||
| =================== | |||
| `Docnet` defines the following markdown extensions to make writing | |||
| ### 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 @alert *name*. Close the @alert with @end. | |||
| ## 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 @alert *name*. Close the `@alert` with `@end`. | |||
| Below are examples for each alert box and the markdown used to create them. | |||
| The markdown: | |||
| @alert danger | |||
| ```nohighlight | |||
| @alert danger | |||
| This is a dangerous text, it will be displayed in a danger alert box! | |||
| @end | |||
| ``` | |||
| @end | |||
| Results in | |||
| results in | |||
| @alert danger | |||
| This is a dangerous text, it will be displayed in a danger alert box! | |||
| @@ -28,11 +24,13 @@ This is a dangerous text, it will be displayed in a danger alert box! | |||
| The markdown: | |||
| @alert warning | |||
| ```nohighlight | |||
| @alert warning | |||
| This is a warning text, it will be displayed in a warning alert box! | |||
| @end | |||
| ``` | |||
| @end | |||
| results in | |||
| @alert warning | |||
| This is a warning text, it will be displayed in a warning alert box! | |||
| @@ -40,10 +38,11 @@ This is a warning text, it will be displayed in a warning alert box! | |||
| The markdown: | |||
| @alert warning\ | |||
| This is an info text, it will be displayed in an info alert box!\ | |||
| @end | |||
| ```nohighlight | |||
| @alert info | |||
| This is an info text, it will be displayed in an info alert box! | |||
| @end | |||
| ``` | |||
| Results in | |||
| @@ -51,65 +50,41 @@ Results in | |||
| This is an info text, it will be displayed in an info alert box! | |||
| @end | |||
| ### Font Awesome icons | |||
| ## Font Awesome icons | |||
| To specify a font-awesome icon, use `@fa-iconname`, where _iconname_ is the name of the font-awesome icon. | |||
| Example: | |||
| ``` | |||
| This will display the font-awesome icon for anchor: @fa-anchor | |||
| ``` | |||
| Example: To specify the font awesome icon for GitHub, use `@fa-github`, which will result in: @fa-github | |||
| ### Tabs | |||
| It's very easy with `Docnet` 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 Joseph Fusco (http://codepen.io/fusco/pen/Wvzjrm) | |||
| ## Tabs | |||
| It's very easy with `Docnet` 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 [Joseph Fusco](http://codepen.io/fusco/pen/Wvzjrm). | |||
| To start a Tab control, start with `@tabs` and end the tabs definition with `@endtabs`. Between those two statements, which each need to be suffixed with a newline, you define one or more tabs using `@tab` followed by the label text for that tab, followed by a newline. End your tab contents with `@end`. | |||
| The following example shows two tabs, one with label 'C#' and one with 'VB.NET': | |||
| @tabs | |||
| @tab C# | |||
| Content 1 2 3 | |||
| ```cs | |||
| var text = DoTabsBlocks("text"); | |||
| ``` | |||
| @end | |||
| @tab VB.NET1 | |||
| Content 1 2 3 | |||
| ```vb | |||
| Dim text = DoTabsBlocks("text") | |||
| ``` | |||
| Additional text | |||
| @end | |||
| @endtabs | |||
| ##Search | |||
| `Docnet` 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. | |||
| *NOTE*: 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. | |||
| ##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`. | |||
| ##Requirements | |||
| `Docnet` 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. | |||
| ##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. | |||
| The following example shows two tabs, one with label 'First Tab' and one with 'Second Tab': | |||
| * [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. | |||
| * [Json.NET](http://www.newtonsoft.com/json). The reading/writing of json files is important for `Docnet` and it uses Json.NET for that. | |||
| ```nohighlight | |||
| @tabs | |||
| @tab First Tab | |||
| This is the text for the first tab. It's nothing special | |||
| I wrote the initial version in roughly 7-8 days, to meet our needs for generating a static searchable documentation site. It therefore might not match what you need or not flexible enough. Feel free to fork the repo and adjust it accordingly! | |||
| ##License | |||
| The MIT License (MIT) | |||
| Copyright (c) 2016 Frans Bouma | |||
| 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! | |||
| @end | |||
| @endtabs | |||
| ``` | |||
| 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: | |||
| will result in: | |||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |||
| @tabs | |||
| @tab First Tab | |||
| This is the text for the first tab. It's nothing special | |||
| 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. | |||
| 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! | |||
| @end | |||
| @endtabs | |||
| @@ -0,0 +1,22 @@ | |||
| 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. | |||
| ##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: | |||
| ```cs | |||
| var i=42; | |||
| ``` | |||
| To specify a block of text in a fixed sized font but not specify any language highlighting, specify `nohighlight` as language name: | |||
| ```nohighlight | |||
| 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`. | |||
| @@ -1,157 +0,0 @@ | |||
| #DocNet | |||
| DocNet is a simple static documentation generator, using markdown files to build the content. | |||
| ##Usage | |||
| The usage is simple: | |||
| docnet *options* *folder* | |||
| *options* can be: | |||
| * -c : clear destination folder. By default `docnet` doesn't remove any file in the destination folder. When specified it will remove all files and folders recursively in the specified `Destination` 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! | |||
| *folder* is the folder where a docnet.json file is expected to be present. | |||
| ##docnet.json | |||
| DocNet uses a json file to determine what to do in what form. The format is straight forward and described below | |||
| ```json | |||
| { | |||
| "Name" : "name of site", | |||
| "Source" : "sourcefolder", | |||
| "Destination" : "destinationfolder", | |||
| "Theme" : "themefolder", | |||
| "SourceFoldersToCopy" : ["folder1", "foldern"], | |||
| "Footer" : "footer text or HTML", | |||
| "Pages" : | |||
| { | |||
| "__index" : "index.md", | |||
| "Title Page 1": "filename_page1.md", | |||
| "Title Page 2": "filename_page2.md", | |||
| "Sub Header 1": | |||
| { | |||
| "__index" : "index.md", | |||
| "Title Page 3" : "filename_page3.md", | |||
| "Title Page 4" : "filename_page4.md" | |||
| } | |||
| } | |||
| } | |||
| ``` | |||
| The order in which the pages are specified is the order in which they'll appear in the navigation. | |||
| * `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. | |||
| * `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). | |||
| * `Pages` 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 `Source`. A file `foo.md` will be generated as `foo.htm` in the output. | |||
| Paths are expected to use `\` characters, and as it's json, you have to escape them, so the path `.\foo` becomes `.\\foo`. | |||
| Each level, starting with the root, has a special page defined, `__index`. This page is the page shown when the level header (in the example above this is e.g. _Sub Header 1_) is clicked in the navigation. If `__index` is specified in the root level, it's assigned to the navigation name `Home`. If there's no `__index` specified, there will still be a page generated but it will have default content (See below). The names of the elements are case sensitive. | |||
| ### Levels without __index defined | |||
| If a level has no `__index` defined, `DocNet` will create a `__index` entry for the level and will specify as target `<path to index of parent>/nameoflevel.md`. 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. | |||
| ## Automatic H2 level ToC entry discovery | |||
| `Docnet` will automatically add all H2 (`##` 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. | |||
| ## Themes | |||
| `Docnet` uses themes to produce output in a certain form. A theme is a folder within the `Themes` folder which contains a `PageTemplate.htm` file and a `Destination` folder which contains zero or more folders and files which have to be copied to the `Destination` folder specified in the `docnet.json` file. | |||
| ### Themes folder | |||
| `Docnet` expects the `Themes` folder to be located in the folder where the executable is started from. This means that if you build `Docnet` 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 `junction` in the bin\debug or bin\release folder to the Themes folder in the source repository, using `mklink` on a windows command prompt. | |||
| ### PageTemplate.htm | |||
| The `PageTemplate.htm` file is a simple HTML file, located in each `theme` folder, which is used as the template for all generated `.htm` files. You can place whatever you like in there, including references to css/js files, headers, footers etc. DocNet however expects a couple of *markers* which are replaced with the data created from the markdown files. These markers are described below. The markers have to be specified as-is. | |||
| * `{{Name}}`. This is replaced with the value specified in `Name` in the `docnet.json` file. | |||
| * `{{Content}}`. This is replaced with the HTML generated from the markdown file. | |||
| * `{{ToC}}`. This is replaced with a `<ul><li></li></ul>` tree built from the names and structure given to pages in `Pages`. | |||
| * `{{TopicTitle}}`. This is replaced with the title of the page, which is the value specified as name in the `Pages` tree. | |||
| * `{{Footer}}`. This is replaced with the value specified in `Footer` in the docnet.json file. | |||
| * `{{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" /> | |||
| ``` | |||
| `Docnet` will then replace `{{Path}}` with e.g. '../../' to get to the css file from the location of the .htm file loaded. | |||
| ##Markdown extensions | |||
| `Docnet` defines the following markdown extensions. | |||
| ### 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 `@alert name`. Close the `@alert` with `@end`. | |||
| Example: | |||
| ```html | |||
| @alert warning | |||
| This is a warning text, it will be displayed in a warning note | |||
| @end | |||
| ``` | |||
| ### Font Awesome icons | |||
| To specify a font-awesome icon, use `@fa-iconname`, where _iconname_ is the name of the font-awesome icon. | |||
| Example: | |||
| ``` | |||
| This will display the font-awesome icon for anchor: @fa-anchor | |||
| ``` | |||
| ### Tabs | |||
| It's very easy with `Docnet` 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 Joseph Fusco (http://codepen.io/fusco/pen/Wvzjrm) | |||
| To start a Tab control, start with `@tabs` and end the tabs definition with `@endtabs`. Between those two statements, which each need to be suffixed with a newline, you define one or more tabs using `@tab` followed by the label text for that tab, followed by a newline. End your tab contents with `@end`. | |||
| The following example shows two tabs, one with label 'C#' and one with 'VB.NET': | |||
| @tabs | |||
| @tab C# | |||
| Content 1 2 3 | |||
| ```cs | |||
| var text = DoTabsBlocks("text"); | |||
| ``` | |||
| @end | |||
| @tab VB.NET1 | |||
| Content 1 2 3 | |||
| ```vb | |||
| Dim text = DoTabsBlocks("text") | |||
| ``` | |||
| Additional text | |||
| @end | |||
| @endtabs | |||
| ##Search | |||
| `Docnet` 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. | |||
| *NOTE*: 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. | |||
| ##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`. | |||
| ##Requirements | |||
| `Docnet` 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. | |||
| ##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. | |||
| * [Json.NET](http://www.newtonsoft.com/json). The reading/writing of json files is important for `Docnet` and it uses Json.NET for that. | |||
| I wrote the initial version in roughly 7-8 days, to meet our needs for generating a static searchable documentation site. It therefore might not match what you need or not flexible enough. Feel free to fork the repo and adjust it accordingly! | |||
| ##License | |||
| The MIT License (MIT) | |||
| Copyright (c) 2016 Frans Bouma | |||
| 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: | |||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |||
| 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. | |||
| @@ -0,0 +1,6 @@ | |||
| Search | |||
| ====== | |||
| `Docnet` 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. | |||
| *NOTE*: 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. | |||
| @@ -0,0 +1,114 @@ | |||
| <!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>Writing content using Markdown - 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 class="current"> | |||
| <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> | |||
| </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> | |||
| | |||
| </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></ul> | |||
| </div> | |||
| <hr /> | |||
| </div> | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <p><h1>Writing content using Markdown</h1></p> | |||
| <p>Please select one of the topic in this section:</p> | |||
| <p><ul> | |||
| <li><a href="markdownsupport.htm">Markdown support</a></li> | |||
| <li><a href="markdownextensions.htm">Markdown extensions</a></li> | |||
| </ul></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> | |||
| @@ -0,0 +1,100 @@ | |||
| <!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> | |||
| | |||
| </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> | |||
| <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> | |||
| </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> | |||
| @@ -48,6 +48,12 @@ | |||
| <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"> | |||
| @@ -46,6 +46,12 @@ | |||
| <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"> | |||
| @@ -39,6 +39,12 @@ | |||
| <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"> | |||
| @@ -70,6 +76,10 @@ | |||
| <p>To see the source of this site, look at the <code>gh-pages</code> branch in the <a href="https://github.com/FransBouma/DocNet">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> | |||
| @@ -0,0 +1,105 @@ | |||
| <!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>License - 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 current"><a class="current" 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> | |||
| | |||
| </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="license.htm">License</a></li></ul> | |||
| </div> | |||
| <hr /> | |||
| </div> | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <p><h1>License</h1></p> | |||
| <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> | |||
| <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> | |||
| </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> | |||
| @@ -8,7 +8,7 @@ | |||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | |||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |||
| <title>Writing content using Markdown - DocNet Documentation</title> | |||
| <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" /> | |||
| @@ -41,18 +41,29 @@ | |||
| <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 current"><a class="current" href="markdownextensions.htm">Writing content using Markdown</a> | |||
| <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="#Markdownextensions">Markdown extensions</a></li> | |||
| <li class="tocentry"><a href="#Search">Search</a></li> | |||
| <li class="tocentry"><a href="#Linking">Linking</a></li> | |||
| <li class="tocentry"><a href="#Requirements">Requirements</a></li> | |||
| <li class="tocentry"><a href="#Acknowledgements">Acknowledgements</a></li> | |||
| <li class="tocentry"><a href="#License">License</a></li> | |||
| <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"> | |||
| @@ -71,124 +82,95 @@ | |||
| <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="markdownextensions.htm">Writing content using Markdown</a></li></ul> | |||
| <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>Writing content using Markdown</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="Markdownextensions"></a><h2>Markdown extensions</h2></p> | |||
| <p><h1>Markdown extensions</h1></p> | |||
| <p><code>Docnet</code> defines the following markdown extensions to make writing </p> | |||
| <p><h3>Alert boxes</h3></p> | |||
| <p><a name="Alertboxes"></a><h2>Alert boxes</h2></p> | |||
| <p>To quickly define alert boxes, <code>Docnet</code> defines the <strong>@alert</strong> 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 <strong>@alert</strong> statement using @alert <em>name</em>. Close the @alert with @end. </p> | |||
| <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 @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>@alert danger</p> | |||
| <p><pre class="nocode">@alert danger | |||
| This is a dangerous text, it will be displayed in a danger alert box! | |||
| @end | |||
| </pre></p> | |||
| <p>This is a dangerous text, it will be displayed in a danger alert box!</p> | |||
| <p>results in</p> | |||
| <p>@end</p> | |||
| <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> | |||
| <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>@alert warning</p> | |||
| <p><pre class="nocode">@alert warning | |||
| This is a warning text, it will be displayed in a warning alert box! | |||
| @end | |||
| </pre></p> | |||
| <p>This is a warning text, it will be displayed in a warning alert box!</p> | |||
| <p>results in</p> | |||
| <p>@end</p> | |||
| <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> | |||
| <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>@alert warning\ | |||
| This is an info text, it will be displayed in an info alert box!\ | |||
| @end</p> | |||
| <p><pre class="nocode">@alert info | |||
| This is an info text, it will be displayed in an info alert box! | |||
| @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><h3>Font Awesome icons</h3></p> | |||
| <p>To specify a font-awesome icon, use <code><i class="fa fa-iconname`,"></i> where <em>iconname</em> is the name of the font-awesome icon.</p> | |||
| <p> | |||
| <p>Example:</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><pre><code class="">This will display the font-awesome icon for anchor: <i class="fa fa-anchor"></i> | |||
| </code></pre></p> | |||
| <p><a name="FontAwesomeicons"></a><h2>Font Awesome icons</h2></p> | |||
| <p><h3>Tabs</h3></p> | |||
| <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>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 Joseph Fusco (http://codepen.io/fusco/pen/Wvzjrm)</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> | |||
| To start a Tab control, start with `<div class="tab-wrap"><input type="radio" id="tab0_1" name="tabGroup1" class="tab" checked><label for="tab0_1">C#</label><input type="radio" id="tab1_1" name="tabGroup1" class="tab"><label for="tab1_1">VB.NET1</label><div class="tab-content">Content 1 2 3 | |||
| </code></pre> | |||
| <p><a name="Tabs"></a><h2>Tabs</h2></p> | |||
| <p><pre><code class="cs"> var text = DoTabsBlocks("text"); | |||
| </code></pre></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> | |||
| <pre><code></div><div class="tab-content">Content 1 2 3 | |||
| </code></pre> | |||
| <p><pre><code class="vb"> Dim text = DoTabsBlocks("text") | |||
| </code></pre></p> | |||
| <pre><code> | |||
| Additional text</div></div> | |||
| </code></pre> | |||
| <p><a name="Search"></a><h2>Search</h2></p> | |||
| <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> | |||
| <p><a name="Linking"></a><h2>Linking</h2></p> | |||
| <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> | |||
| <p><a name="Requirements"></a><h2>Requirements</h2></p> | |||
| <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> | |||
| <p><a name="Acknowledgements"></a><h2>Acknowledgements</h2></p> | |||
| <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> | |||
| </ul> | |||
| I wrote the initial version in roughly 7-8 days, to meet our needs for generating a static searchable documentation site. It therefore might not match what you need or not flexible enough. Feel free to fork the repo and adjust it accordingly! | |||
| <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><a name="License"></a><h2>License</h2></p> | |||
| <p>The following example shows two tabs, one with label 'First Tab' and one with 'Second Tab':</p> | |||
| <p>The MIT License (MIT)</p> | |||
| <p><pre class="nocode">@tabs | |||
| @tab First Tab | |||
| This is the text for the first tab. It's nothing special</p> | |||
| <p>Copyright (c) 2016 Frans Bouma</p> | |||
| <p>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! | |||
| @end | |||
| @endtabs | |||
| </pre></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>will result in: </p> | |||
| <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> | |||
| <p><div class="tab-wrap"><input type="radio" id="tab0_1" name="tabGroup1" class="tab" checked><label for="tab0_1">First</label><input type="radio" id="tab1_1" name="tabGroup1" class="tab"><label for="tab1_1">Second</label><div class="tab-content">Tab | |||
| This is the text for the first tab. It's nothing special</p> | |||
| <p>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>As you can see, it can deal with newlines as well. </div><div class="tab-content">Tab | |||
| Now, the second tab however is very interesting. At least let's pretend it is!</div></div></p> | |||
| </div> | |||
| </div> | |||
| @@ -0,0 +1,130 @@ | |||
| <!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="#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> | |||
| | |||
| </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> | |||
| <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 <pre> block | |||
| </pre></p> | |||
| <p><a name="Linking"></a><h2>Linking</h2></p> | |||
| <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> | |||
| @@ -0,0 +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>Search - 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 current"><a class="current" 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> | |||
| | |||
| </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="search.htm">Search</a></li></ul> | |||
| </div> | |||
| <hr /> | |||
| </div> | |||
| <div role="main"> | |||
| <div class="section"> | |||
| <p><h1>Search</h1></p> | |||
| <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> | |||
| </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> | |||
| @@ -24,11 +24,35 @@ | |||
| "keywords": "a A all and are as based be been below bin binary bread Breadcrumbs build built by called can certain chosen coded command contains Content copied copy could couple create created crumbs css current data debug default Default definitions delimited described Destination development docnet Docnet DocNet docnetjson e each easier etc executable expects extra ExtraScript file files fill folder folders Footer footers for form from g generated get given hard has have headers however href htm HTML if in including is isn It js json junction li like link list loaded located location look make making manually markdown marker markers means MkDocs mklink more name Name names navigation no of on one or output page pages Pages PageTemplate path Path place present produce prompt reach ReadTheDocs references rel relative release replace replaced repository representing required script search shipped should simple some source specific specified specifying started structure stylesheet template text that the The theme themes Themes then there These this This through title to To ToC TopicTitle tree type ul up URL URLs used uses using value whatever where which will windows with within won work you You your zero", | |||
| "title": "Themes" | |||
| }, | |||
| { | |||
| "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", | |||
| "title": "Markdown support" | |||
| }, | |||
| { | |||
| "location": "markdownextensions.htm", | |||
| "breadcrumbs": "Home / Authoring content / Writing content using Markdown", | |||
| "keywords": "_iconname_ 1 2 20 2016 20to 3 4 6 64 7 8 a A above accordingly Acknowledgements ACTION add added AddEntity Additional adjust after against alert Alert alerts all allow also an AN anchor and AND any ANY application are ARISING as AS associated at AUTHORS awesome Awesome based be BE because below Below besides Between block blue borrows Bouma box boxes builds but BUT by c C called can charge choice Chrome CLAIM cleaned Close code codepen com come compiled conditions CONNECTION contains content Content contents CONTRACT control convert converted copies copy copyright Copyright COPYRIGHT create cross cs css CSS3 DAMAGES danger dangerous days deal DEALINGS default define defined defines definition described destination Dim disk display displayed distribute do docnet Docnet DocNet document documentation doesn DoTabsBlocks due each easy Either element end End endtabs enough escape EVENT example Example examples EXPRESS extended extensions fa features Feel file files Firefox first FITNESS flexible folder followed following font Font for For FOR fork Frans free from FROM full furnished fusco Fusco future general generate generating get github GithubCodeBlocks Gobel good granted great has hereby highly HOLDERS How htm HTML http https I icon iconname icons If IMPLIED important in In IN included including INCLUDING incomplete index info initial input into io is IS it It javascript Joseph json Json KIND Kyle KyleGobel label latest LIABILITY LIABLE License likely limitation LIMITED link Linking links list loads locally locate locating logical lower make markdown Markdown MarkdownSharp markers match md means meet MERCHANTABILITY merge Microsoft might MIT mkdocs MkDocs modify moment Mono more name need needs NET NET1 neutral newline newtonsoft NO NONINFRINGEMENT not Not NOT NOTE notice obtaining of OF on one ones only or OR order org origin OTHER others OTHERWISE our OUT page pages parsed parser PARTICULAR pen permission Permission permit person persons piece portions possible present problem protection PROVIDED publish pure PURPOSE purposes quickly reading Readthedocs red regarding repo Requirements requires restriction result Results rights root roughly run search Search search_data searchable sell sentence served server set shall SHALL should shows simple site so software Software SOFTWARE space spaces specific specified specify StackExchange start statement statements static style subject sublicense substantial suffixed supports tab Tab tabs Tabs template tested text that the The THE their them theme therefore this This those Three to To TO topic TORT transform transformation two type types up updated upon url urls use USE used uses using usual var vb VB version versions very want warning WARRANTIES WARRANTY was well what where WHETHER which whom will with WITH without WITHOUT won word work works wouldn writing Writing wrote Wvzjrm www x yellow you You your", | |||
| "title": "Writing content using Markdown" | |||
| "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" | |||
| }, | |||
| { | |||
| "location": "search.htm", | |||
| "breadcrumbs": "Home / Search", | |||
| "keywords": "a and based because can Chrome come cross destination disk Docnet documentation due Either enough file Firefox first folder For from general generate good in index is it It javascript json list loads locally locate locating NOTE of on or order origin pages piece protection purposes regarding root search Search search_data sentence served server simple site specified template text the them to topic use used which will with won word work", | |||
| "title": "Search" | |||
| }, | |||
| { | |||
| "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", | |||
| "title": "Acknowledgements" | |||
| }, | |||
| { | |||
| "location": "license.htm", | |||
| "breadcrumbs": "Home / License", | |||
| "keywords": "2016 a A above ACTION all AN and AND any ANY ARISING AS associated AUTHORS be BE Bouma BUT c charge CLAIM conditions CONNECTION CONTRACT copies copy copyright Copyright COPYRIGHT DAMAGES deal DEALINGS distribute do DocNet documentation EVENT EXPRESS files FITNESS following FOR Frans free FROM furnished granted hereby HOLDERS IMPLIED in IN included including INCLUDING is IS KIND LIABILITY LIABLE license License licensed limitation LIMITED MERCHANTABILITY merge MIT modify NO NONINFRINGEMENT NOT notice obtaining of OF or OR OTHER OTHERWISE OUT PARTICULAR permission Permission permit person persons portions PROVIDED publish PURPOSE restriction rights sell shall SHALL so software Software SOFTWARE subject sublicense substantial the The THE this to TO TORT under use USE WARRANTIES WARRANTY WHETHER whom WITH without WITHOUT", | |||
| "title": "License" | |||
| } | |||
| ] | |||
| } | |||
| @@ -45,11 +45,18 @@ | |||
| <li class="tocentry"><a href="#Defaulttheme">Default theme</a></li> | |||
| <li class="tocentry"><a href="#PageTemplatehtm">PageTemplate.htm</a></li> | |||
| </ul> | |||
| <li class="tocentry"><a href="markdownextensions.htm">Writing content using Markdown</a> | |||
| <li class="tocentry"> | |||
| <span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="WritingcontentusingMarkdown.htm">Writing content using Markdown</a></span> | |||
| </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"> | |||
| @@ -41,6 +41,12 @@ | |||
| <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"> | |||