From bee8b325aae43a90eb7a65322cffa7cbf8b4ecac Mon Sep 17 00:00:00 2001 From: Frans Bouma Date: Tue, 6 Feb 2018 13:53:50 +0100 Subject: [PATCH] updated docs --- css/theme_colors.css | 2 +- docnetjson.htm | 21 +++++++++++++-------- h2leveldiscovery.htm | 2 +- markdownsupport.htm | 2 +- search_index.json | 2 +- usage.htm | 2 +- 6 files changed, 18 insertions(+), 13 deletions(-) diff --git a/css/theme_colors.css b/css/theme_colors.css index b462a69..dd4bcd5 100644 --- a/css/theme_colors.css +++ b/css/theme_colors.css @@ -181,7 +181,7 @@ mark { color: #2980B9; } -.menu-vertical ul.currentrelative, .menu-vertical ul.currentrelativeroot { +.menu-vertical ul.currentrelative { background-color: #e3e3e3; } diff --git a/docnetjson.htm b/docnetjson.htm index 4a673f0..6e86861 100644 --- a/docnetjson.htm +++ b/docnetjson.htm @@ -62,6 +62,8 @@
  • Footer
    • +
  • StartingPageName
    • +
  • Pages
  • Levels without __index defined
    • @@ -122,17 +124,18 @@ "Theme" : "themefolder", "SourceFoldersToCopy" : ["folder1", "foldern"], "Footer" : "footer text or HTML", - "ConvertLocalLinks: "true" | "false", - "PathSpecification": "Full" | "Relative" | "RelativeAsFolder", - "UrlFormatting": "None" | "Strip" | "Dashes", - "MaxLevelInToC": "3", - "StripIndexHtm": "true" | "false", + "StartingPageName" : "Home", + "ConvertLocalLinks" : "true" | "false", + "PathSpecification" : "Full" | "Relative" | "RelativeAsFolder", + "UrlFormatting" : "None" | "Strip" | "Dashes", + "MaxLevelInToC" : "3", + "StripIndexHtm" : "true" | "false", "Pages" : { "__index" : "index.md", - "Title Page 1": "filename_page1.md", - "Title Page 2": "filename_page2.md", - "Sub Header 1": + "Title Page 1" : "filename_page1.md", + "Title Page 2" : "filename_page2.md", + "Sub Header 1" : { "__index" : "index.md", "Title Page 3" : "filename_page3.md", @@ -181,6 +184,8 @@
    Important!

    Note that setting this value to true will remove the possibility to view the docs off-line

    This is text and/or HTML which is placed in the footer of each page, using a marker (see below).

    +

    StartingPageName

    +

    This is the name used for the home/starting page, i.e. the __index page at the root level. The default value is "Home".

    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.

    diff --git a/h2leveldiscovery.htm b/h2leveldiscovery.htm index 5e2dfce..9bc59f8 100644 --- a/h2leveldiscovery.htm +++ b/h2leveldiscovery.htm @@ -81,7 +81,7 @@

    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.

    -

    This behavior can be overridden by the MaxLevelInToC configuration option.

    +

    This behavior can be overridden by the MaxLevelInToC configuration option.

    Info

    Note that level 1 headings (titles) are never shown in the ToC).

    diff --git a/markdownsupport.htm b/markdownsupport.htm index a42386b..6dedd63 100644 --- a/markdownsupport.htm +++ b/markdownsupport.htm @@ -206,7 +206,7 @@ If you want to have an image rendered centered with a note below it, simply spec

    To specify a block of text in a fixed sized font but not specify any language highlighting, specify nohighlight as language name:

    this is a simple <pre> block

    Linking

    -

    Docnet doesn't automatically transform links to markdown files by default. To enable automatic link conversion to local markdown files, please specify the ConvertLocalLinks option in the docnet.json file file with the value true. If ConvertLocalLinks isn't specified or set to false, any link to any document in your documentation has to use the url it will get in the destination folder.

    +

    Docnet doesn't automatically transform links to markdown files by default. To enable automatic link conversion to local markdown files, please specify the ConvertLocalLinks option in the docnet.json file file with the value true. If ConvertLocalLinks isn't specified or set to false, 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. If ConvertLocalLinks isn't specified or set to false, you have to specify in the markdown the url it will need to be in the result site, which is the link How%20to/AddEntity.htm. If ConvertLocalLinks is set to true, you can specify How%20to/AddEntity.md and DocNet will convert it to How%20to/AddEntity.htm.

    Important!

    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/search_index.json b/search_index.json index c26cd76..94e7aba 100644 --- a/search_index.json +++ b/search_index.json @@ -9,7 +9,7 @@ { "location": "docnetjson.htm", "breadcrumbs": "Home / Configuration / Site configuration with the docnet.json file", - "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined commas compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create dash Dashes default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation Does doesn dots e E each Each elements empty end ending entry escape etc every example Example except executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format formatted forward from full Full g generate Generate generated getting given guarantees has have header Header headings Home how href htm HTML if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction Introduction is isn it It its json later lead level Levels line link links list load loaded local located make markdown markdownextensions marker MaxLevelInToC md more mostly my mydocumentation name Name nameoflevel names navigated navigation never no non Non None not Note of off one only optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove removing Replaces result resulting results retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so some Some someintroduction somemarkdownfile source Source sourcefolder SourceFoldersToCopy spaces special specified Specifies specify started starting still straight string strip Strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle touch treated tree true unique unsupported UrlFormatting urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", + "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes at auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined commas compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create dash Dashes default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation Does doesn dots e E each Each elements empty end ending entry escape etc every example Example except executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format formatted forward from full Full g generate Generate generated getting given guarantees has have header Header headings home Home how href htm HTML i if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction Introduction is isn it It its json later lead level Levels line link links list load loaded local located make markdown markdownextensions marker MaxLevelInToC md more mostly my mydocumentation name Name nameoflevel names navigated navigation never no non Non None not Note of off one only optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove removing Replaces result resulting results retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so some Some someintroduction somemarkdownfile source Source sourcefolder SourceFoldersToCopy spaces special specified Specifies specify started starting StartingPageName still straight string strip Strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle touch treated tree true unique unsupported UrlFormatting urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", "title": "Site configuration with the docnet.json file" }, { diff --git a/usage.htm b/usage.htm index 459c080..3e0ecca 100644 --- a/usage.htm +++ b/usage.htm @@ -32,7 +32,7 @@
  • Usage -