Add docs for the wildcard inclusion feature #60
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FransBouma
reviewed
Jun 13, 2017
MarkdownSource/docnetjson.md
Outdated
| @@ -46,3 +47,14 @@ Each level, starting with the root, has a special page defined, `__index`. This | |||
|
|
|||
| ## 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. | |||
|
|
|||
| ## Use of wildcard inclusions | |||
| If a level has a string value ending with `**`, it will automatically generate the files for all the (sub)folders. It will use the following process: | |||
There was a problem hiding this comment.
it will automatically generate the files for all the (sub)folders
'it will process all .md files in the folders and subfolders and generate htm files from them.'
|
Besides the remark, it looks good to me! |
|
Done. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.