Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for the wildcard inclusion feature #60

Merged
merged 2 commits into from
Jun 14, 2017
Merged

Add docs for the wildcard inclusion feature #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d4585d
Add docs for the wildcard inclusion feature
GeertvanHorrik Jun 13, 2017
7896e70
Update docs based on feedback
GeertvanHorrik Jun 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion MarkdownSource/docnetjson.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ DocNet uses a json file to determine what to do in what form. The format is stra
"__index" : "index.md",
"Title Page 3" : "filename_page3.md",
"Title Page 4" : "filename_page4.md"
}
},
"Auto generated" : "reference/**"
}
}
```
Expand All @@ -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 process all .md files in the folders and subfolders and generate htm files from them. It will use the following process:

1. Search (recursively) for all markdown (`.md`) files inside the specified folder (e.g. `reference`)
2. Generate index (htm) files for all folders
3. The title of the markdown files will be retrieved from the actual markdown files (so the first non-empty line will be used as title)

@alert info
The wildcard inclusion feature is extremely useful for referene or API documentation (mostly generated by a 3rd party tool)
@end