Skip to content

Commit

Permalink
docs(readme): Document new theme configuration option
Browse files Browse the repository at this point in the history
  • Loading branch information
pklaschka committed Jan 8, 2021
1 parent ec30134 commit bdbd4c4
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,14 @@ Options:
Get help for individual commands by running fliegdoc <command> --help
```

The CLI searches for a `fliegdoc.config.js` file and applies its options on top of the default options.
The CLI searches for a `fliegdoc.config.js` file and applies its options **on top of the default options**.

#### Example `fliegdoc.config.js` with default options

```js
// fliegdoc.config.js
const { HTMLTheme } = require('fliegdoc');

module.exports = {
baseUrl: '/',
outDir: './docs',
Expand All @@ -62,7 +64,8 @@ module.exports = {
],
title: 'Documentation', // appears in the page title and header
externalLinks: {}, // e.g.: { "GitHub": "https://github.com/fliegwerk/fliegdoc" }
hidePrivateMembers: true
hidePrivateMembers: true,
theme: HTMLTheme
};
```

Expand Down

0 comments on commit bdbd4c4

Please sign in to comment.