./src/defaults.js annotated source

Back to index 

        

        
The default configuration file if the user doesn't specify a value
for any options


3module.exports = {


4


5    name: 'My Project',


6    description: 'Replace this description by setting the `description` option on `litterate`, or leave it blank',


7


Don't wrap lines


9    wrap: 0,


10


By default, it makes sense to assume that the root of the site
is just '/'


13    baseURL: '/',


14    verbose: false,


15


It's reasonable to assume that most projects keep the main source files in
./src/, so that's the default files option. We may reverse this call in the future
though to be blank by default.


19    files: [


20        './src/**/*.js',


21    ],


22


We default to this because this is where GitHub Pages pulls from.


24    outputDirectory: './docs/',


25


26    annotationStartMark: '//>',


27    annotationContinueMark: '//',


28}


29