Skip to content

Instantly share code, notes, and snippets.

@foxleigh81
Last active August 22, 2017 10:25
Show Gist options
  • Save foxleigh81/4fd0813787cbbe33b73b97067dce2583 to your computer and use it in GitHub Desktop.
Save foxleigh81/4fd0813787cbbe33b73b97067dce2583 to your computer and use it in GitHub Desktop.
clarity.json config file
# Author needs to be specified in order to generate accurate documentation
author :
name: "Alex Foxleigh"
giturl : "https://github.com/foxleigh81"
defaults:
# viewType will specify the file extension used for views. Any extension can be used here (ommit the '.'')
viewType : "njk"
# viewType will specify the preprocessor used for styles. At the moment only Stylus (.styl) is supported
styleType: "stylus"
# createRegister will - if set to true - create a 'component-register.html' file in the project root.
# This will show an infotable about each component
createRegister: true
@foxleigh81
Copy link
Author

foxleigh81 commented Aug 22, 2017

This is the clarity.yml config file and it is required in order for the ctgen package to work. It should be added to .gitignore if more than one person will be using ctgen as the config is unique to each developer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment