Skip to content

Commit

Permalink
add an option to exclude the file list in homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
@ankitskvmdam
ankitskvmdam committed Dec 20, 2022
1 parent 64b9595 commit 597cacf
Show file tree
Hide file tree
Showing 51 changed files with 8,067 additions and 76 deletions.
45 changes: 23 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# clean-jsdoc-theme

[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-4.1.12-005bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![license](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE)
[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-4.2.0-005bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![license](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE)
<br>

`clean-jsdoc-theme` is a beautifully crafted theme for JSDoc 3/JSDoc 4. It is a clean and fully responsive theme with loads of
Expand Down Expand Up @@ -424,27 +424,28 @@ This will remove all symbols (members, methods ...) that come from inherited par

## Cheat sheet

| 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` |

Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.

Expand Down
3 changes: 2 additions & 1 deletion jsdoc-config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"allowUnknownTags": true
},
"source": {
"include": ["./demo/src", "./README.md"]
"include": ["./demo/src", "./README.md", "./static/scripts/core.js"]
},
"plugins": ["plugins/markdown"],
"opts": {
Expand All @@ -13,6 +13,7 @@
"template": "./",
"tutorials": "./demo/src/tutorials",
"theme_opts": {
"includeFilesListInHomepage": true,
"search": true,
"homepageTitle": "Clean JSDoc Theme",
"default_theme": "dark",
Expand Down
Loading

0 comments on commit 597cacf

Please sign in to comment.