diff --git a/CHANGELOG.md b/CHANGELOG.md index 41890703..3343d4e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ ## Change Log +### In version 4.2.0 + +1. Add an option to include files list in homepage. Previously we are including it by default. From now the developer has to explicitly ask for it. For more [see](https:/github.com/ankitskvmdam/clean-jsdoc-theme#add-files-list-in-homepage) + ### In version 4.0.0 This is the most performant version of `clean-jsdoc-theme`. Check @@ -253,4 +257,4 @@ In this release we removed this template rule. 1. Fix typescript-eslint camelCase rule issue [issue: [#37](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues/37)] 2. Fix ordered list style [issue: [#40](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues/40)] -3. Fix code overflow issue. \ No newline at end of file +3. Fix code overflow issue. diff --git a/README.md b/README.md index 31ec9862..e1e51dca 100644 --- a/README.md +++ b/README.md @@ -177,6 +177,18 @@ example of this is below: You can use [`static_dir`](#add-static-dir) option to copy all you static files to output dir and use that path in place of `path/to/img`. +### Add files list in homepage + +By default `clean-jsdoc-theme` will not include the list of files in the homepage. If you want to add them the do the following + +```json +"theme_opts": { + "includeFilesListInHomepage": true // by default it is false. +} +``` + +> Note: You need to add @file tag in the .js if you want to include it in the file list. For more details on `@file` visit: https://jsdoc.app/tags-file.html + ### Add navbar menu To render extra link(s) in navbar. It accepts an array of objects: