-
Authoring content
- +Authoring content
Please select one of the topic in this section:
- -Please select one of the topic in this section:
- -Please select one of the topic in this section:
- - 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`.
\ No newline at end of file
+`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`.
+
+
diff --git a/MarkdownSource/themes.md b/MarkdownSource/themes.md
index a39d5ff..2b9e6b8 100644
--- a/MarkdownSource/themes.md
+++ b/MarkdownSource/themes.md
@@ -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
-
-```
+ ```HTML
+
+ ```
`Docnet` will then replace `{{Path}}` with e.g. '../../' to get to the css file from the location of the .htm file loaded.
diff --git a/WritingcontentusingMarkdown.htm b/WritingcontentusingMarkdown.htm
index e29ba53..585b6a2 100644
--- a/WritingcontentusingMarkdown.htm
+++ b/WritingcontentusingMarkdown.htm
@@ -46,7 +46,7 @@
Please select one of the topic in this section:
- -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.
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:
- -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 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.
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.
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.
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.
The default theme is called Default and is chosen if no theme has been specified in the docnet.json file. It is based on the theme from ReadTheDocs, and is created from the one shipped with MkDocs.
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. {{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:{{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:
+<link rel="stylesheet" href="{{Path}}css/theme.css" type="text/css" />
+<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.
Docnet will then replace {{Path}} with e.g. '../../' to get to the css file from the location of the .htm file loaded.
+The usage is simple:
-docnet options folder
-options can be:
- -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!
-
+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 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.