clean-jsdoc-theme
Advanced tools
clean-jsdoc-theme - npm Package Compare versions
Comparing version 4.1.12 to 4.2.0
@@ -6,3 +6,3 @@ { | ||
| "source": { | ||
| "include": ["./demo/src", "./README.md"] | ||
| "include": ["./demo/src", "./README.md", "./static/scripts/core.js"] | ||
| }, | ||
@@ -17,2 +17,3 @@ "plugins": ["plugins/markdown"], | ||
| "theme_opts": { | ||
| "includeFilesListInHomepage": true, | ||
| "search": true, | ||
@@ -19,0 +20,0 @@ "homepageTitle": "Clean JSDoc Theme", |
| { | ||
| "name": "clean-jsdoc-theme", | ||
| "version": "4.1.12", | ||
| "version": "4.2.0", | ||
| "description": "A beautifully crafted theme/template for JSDoc 3. This theme/template looks and feels like a premium theme/template. This is a fully mobile responsive theme and also fully customizable theme.", | ||
@@ -5,0 +5,0 @@ "main": "publish.js", |
@@ -895,2 +895,3 @@ const _ = require('lodash'); | ||
| const homepageTitle = themeOpts.homepageTitle || 'Home'; | ||
| const includeFilesListInHomepage = themeOpts.includeFilesListInHomepage || false | ||
@@ -909,3 +910,3 @@ generate( | ||
| ]) | ||
| .concat(files), | ||
| .concat(includeFilesListInHomepage ? files : []), | ||
| indexUrl | ||
@@ -912,0 +913,0 @@ ); |
| # clean-jsdoc-theme | ||
| [](https://github.com/ankitskvmdam/clean-jsdoc-theme) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork)  [](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) | ||
| [](https://github.com/ankitskvmdam/clean-jsdoc-theme) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork)  [](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) | ||
| <br> | ||
@@ -427,23 +427,24 @@ | ||
| | name | default | use case | expected value(s) | | ||
| | --------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | --------------------- | | ||
| | `default_theme` | `"dark"` | To set the default theme | `"light" or "dark"` | | ||
| | `homepageTitle` | "Home" | To set the title of homepage | `string` | | ||
| | `title` | `null` | To set the title | `HTML` or `string` | | ||
| | `base_url` | `/` | To set the base URL | `string` | | ||
| | `menu` | `null` | To render extra link in navbar | Array of Object(s) | | ||
| | `meta` | `null` | Meta tag attributes | Array of Object(s) | | ||
| | `search` | `true` | To render search or not | `true` or `false` | | ||
| | `codepen` | `{}` | To open code in codepen | `Object` | | ||
| | `static_dir` | `null` | To include static dir | Array of string | | ||
| | `create_style` | `null` | To create custom style rules | `string` | | ||
| | `add_style_path` | `null` | To add external css libraries/files | Array of Object(s) | | ||
| | `include_css` | `null` | To include css files | Array of string | | ||
| | `add_scripts` | `null` | To create custom script | `string` | | ||
| | `add_script_path` | `null` | To add external js libraries/files | Array of Object(s) | | ||
| | `include_js` | `null` | To include js files | `string` | | ||
| | `footer` | `null` | To render footer | `HTML` or `string` | | ||
| | `exclude_inherited` | `false` | To exclude inherited symbols | `boolean` | | ||
| | `sections` | `["Modules", "Classes", "Externals", "Events", "Namespaces", "Mixins", "Tutorials", "Interfaces", "Global"]` | To order navbar/sidebar sections or to hide/remove navbar/sidebar sections | `Array<SECTION_TYPE>` | | ||
| | `displayModuleHeader` | `false` | If you want the module name to appear on its page | `boolean` | | ||
| | name | default | use case | expected value(s) | | ||
| | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | --------------------- | | ||
| | `default_theme` | `"dark"` | To set the default theme | `"light" or "dark"` | | ||
| | `homepageTitle` | "Home" | To set the title of homepage | `string` | | ||
| | `title` | `null` | To set the title | `HTML` or `string` | | ||
| | `base_url` | `/` | To set the base URL | `string` | | ||
| | `menu` | `null` | To render extra link in navbar | Array of Object(s) | | ||
| | `meta` | `null` | Meta tag attributes | Array of Object(s) | | ||
| | `search` | `true` | To render search or not | `true` or `false` | | ||
| | `codepen` | `{}` | To open code in codepen | `Object` | | ||
| | `static_dir` | `null` | To include static dir | Array of string | | ||
| | `create_style` | `null` | To create custom style rules | `string` | | ||
| | `add_style_path` | `null` | To add external css libraries/files | Array of Object(s) | | ||
| | `include_css` | `null` | To include css files | Array of string | | ||
| | `add_scripts` | `null` | To create custom script | `string` | | ||
| | `add_script_path` | `null` | To add external js libraries/files | Array of Object(s) | | ||
| | `include_js` | `null` | To include js files | `string` | | ||
| | `footer` | `null` | To render footer | `HTML` or `string` | | ||
| | `exclude_inherited` | `false` | To exclude inherited symbols | `boolean` | | ||
| | `sections` | `["Modules", "Classes", "Externals", "Events", "Namespaces", "Mixins", "Tutorials", "Interfaces", "Global"]` | To order navbar/sidebar sections or to hide/remove navbar/sidebar sections | `Array<SECTION_TYPE>` | | ||
| | `displayModuleHeader` | `false` | If you want the module name to appear on its page | `boolean` | | ||
| | `includeFilesListInHomepage` | `false` | If you want to add or remove the list of files in homepage | `boolean` | | ||
@@ -450,0 +451,0 @@ Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.06%
955521
- Lines of code
- increased by0.02%
9272
- Number of lines in readme file
- increased by0.2%
500
No dependency changes