From bdbd4c48fd4d9e94f314f5b2d9cede2d757c9949 Mon Sep 17 00:00:00 2001 From: Pablo Klaschka Date: Fri, 8 Jan 2021 17:51:39 +0100 Subject: [PATCH] docs(readme): Document new theme configuration option --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 473e4cd0..fecf1b1e 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,14 @@ Options: Get help for individual commands by running fliegdoc --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', @@ -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 }; ```