.hologramrc
# Hologram will run from same directory where this config file resides
# All paths should be relative to there
title: Example title
subtitle: Example subtitle
# The directory containing the source files to parse recursively
source: ./app
# The directory that hologram will build to
destination: ./dist/docs
# 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: ./libraries/voxel-hologram/dist
# The folder that contains templates for rendering code examples.
# If you want to change the way code examples appear in the styleguide,
# modify the files in this folder
code_example_templates: ./libraries/voxel-hologram/dist/_templates/code_examples_templates
# The folder that contains custom code example renderers.
# If you want to create additional renderers that are not provided
# by Hologram (i.e. coffeescript renderer, jade renderer, etc)
# place them in this folder
code_example_renderers: ./libraries/voxel-hologram/dist/_templates/code_example_renderers
# 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:
- ./libraries/voxel/dist/images
- ./libraries/voxel/dist/fonts
# List all CSS files to include for the styleguide render examples (path from styleguide directory)
css_include:
- '../styles/main.css'
# List all JavaScript files to include for the styleguide render examples (path from styleguide directory)
js_include:
-
# RequireJS main file (path from styleguide directory)
requirejs_main: '../scripts/main.js'
# Bower components dir (path from styleguide directory)
bower_components_dir: '../../libraries'
# String used to split the category name and create category titles
name_scope: ' - '
# This string is used to set the color theme for Voxel.
# Available themes: 'red', 'pink', 'purple', 'deep-purple', 'indigo', 'blue', 'light-blue', 'cyan', 'teal', 'green', 'light-green', 'lime', 'yellow', 'amber', 'orange', 'deep-orange', 'brown', 'gray', 'blue-gray'
voxel_theme: 'light-green'
# 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
# Hologram 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 Hologram to exit on these warnings, set the value to 'true'
# (Default value is 'false')
exit_on_warnings: true