Skip to content

Add docs for the wildcard inclusion feature#60

Merged
FransBouma merged 2 commits intoFransBouma:gh-pagesfrom
GeertvanHorrik:pr/wildcard-inclusions-docs
Jun 14, 2017
Merged

Add docs for the wildcard inclusion feature#60
FransBouma merged 2 commits intoFransBouma:gh-pagesfrom
GeertvanHorrik:pr/wildcard-inclusions-docs

Conversation

@GeertvanHorrik
Copy link
Copy Markdown
Contributor

No description provided.

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:
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.'

@FransBouma
Copy link
Copy Markdown
Owner

Besides the remark, it looks good to me!

@GeertvanHorrik
Copy link
Copy Markdown
Contributor Author

Done.

@FransBouma FransBouma merged commit b807e2d into FransBouma:gh-pages Jun 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants