Options that may be used with grunt-build-include statements.
In most cases it is recommended to use the options to set configuration options for a build_include statement.
This allows for fine control of how each build_include statement is processed.
Grunt-build-include is mainly a wrapper for build-include package. Docs for build-include can be viewed here with extensive with many examples and options.
Sometimes more of a global approach is perfered. In these cases Grunt File level options can be applied.
Consider the following scenario.
Your using a document generator in your TypeScript project that allows for [[include:somePath/somefile.md]]
type include statments to be replaced by file contents during the document generation process. This might be preferable when you need finer control over markdown of some comments.
The down side to this approach is any file.d.ts
types documents will contain [[include:somePath/somefile.md]]
statments which may not be helpful for code completion help.
Using a Grunt File configuraton can be helpful to transform your file.d.ts
outputs to have [[include:somePath/somefile.md]]
includes replaced with the actual markdown contents.
Generated using TypeDoc