| 1 | //> The default configuration file if the user doesn't specify a value
|
| 2 | // for any options
|
| 3 | module.exports = {
|
| 4 |
|
| 5 | name: 'My Project',
|
| 6 | description: 'Replace this description by setting the `description` option on `litterate`, or leave it blank',
|
| 7 |
|
| 8 | //> Don't wrap lines
|
| 9 | wrap: 0,
|
| 10 |
|
| 11 | //> By default, it makes sense to assume that the root of the site
|
| 12 | // is just `'/'`
|
| 13 | baseURL: '/',
|
| 14 | verbose: false,
|
| 15 |
|
| 16 | //> It's reasonable to assume that most projects keep the main source files in
|
| 17 | // `./src/`, so that's the default files option. We may reverse this call in the future
|
| 18 | // though to be blank by default.
|
| 19 | files: [
|
| 20 | './src/**/*.js',
|
| 21 | ],
|
| 22 |
|
| 23 | //> We default to this because this is where GitHub Pages pulls from.
|
| 24 | outputDirectory: './docs/',
|
| 25 |
|
| 26 | annotationStartMark: '//>',
|
| 27 | annotationContinueMark: '//',
|
| 28 | }
|