-
Notifications
You must be signed in to change notification settings - Fork 3
/
holograph_config.js
37 lines (36 loc) · 1.49 KB
/
holograph_config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// Holograph will run from same directory where this config file resides
// All paths should be relative to there
module.exports = {
// The directory containing the source files to parse recursively
source: './scss',
// The directory that holograph will build to
destination: './holograph',
// The assets needed to build the docs (includes _header.html,
// _footer.html, etc)
// You may put doc related assets here too: images, css, etc.
documentation_assets: './node_modules/holograph/assets',
// Any other asset folders that need to be copied to the destination
// folder. Typically this will include the css that you are trying to
// document. May also include additional folders as needed.
dependencies: [
'css'
],
css_include: [
'css/example.css'
],
// Mark which category should be the index page
// Alternatively, you may have an index.md in the documentation assets
// folder instead of specifying this config.
index: 'basics',
// To additionally output navigation for top level sections, set the value to
// 'section'. To output navigation for sub-sections,
// set the value to `all`
// nav_level: all
// Holograph displays warnings when there are issues with your docs
// (e.g. if a component's parent is not found, if the _header.html and/or
// _footer.html files aren't found)
// If you want Holograph to exit on these warnings, set the value to 'true'
// (Default value is 'false')
exit_on_warnings: false,
global_title: 'Holograph stylesheet'
}