{"id":13425146,"url":"https://github.com/ankitskvmdam/clean-jsdoc-theme","last_synced_at":"2025-03-15T19:32:41.134Z","repository":{"id":36007363,"uuid":"220757541","full_name":"ankitskvmdam/clean-jsdoc-theme","owner":"ankitskvmdam","description":"A beautifully crafted theme / template for JSDoc 3. https://ankdev.me/clean-jsdoc-theme/v4","archived":false,"fork":false,"pushed_at":"2024-08-01T22:34:33.000Z","size":7973,"stargazers_count":172,"open_issues_count":13,"forks_count":43,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-07T07:36:11.434Z","etag":null,"topics":["jsdoc","jsdoc-template","jsdoc-theme"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/clean-jsdoc-theme","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ankitskvmdam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-10T07:41:52.000Z","updated_at":"2025-03-04T07:46:50.000Z","dependencies_parsed_at":"2023-09-24T12:08:20.114Z","dependency_job_id":"cb139d3a-f919-473a-8dad-9385f16d74e1","html_url":"https://github.com/ankitskvmdam/clean-jsdoc-theme","commit_stats":{"total_commits":761,"total_committers":24,"mean_commits":"31.708333333333332","dds":0.5321944809461235,"last_synced_commit":"eebd46d31777106171ffa0573ae8825b228fab1d"},"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitskvmdam%2Fclean-jsdoc-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitskvmdam%2Fclean-jsdoc-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitskvmdam%2Fclean-jsdoc-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitskvmdam%2Fclean-jsdoc-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankitskvmdam","download_url":"https://codeload.github.com/ankitskvmdam/clean-jsdoc-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243781860,"owners_count":20347157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jsdoc","jsdoc-template","jsdoc-theme"],"created_at":"2024-07-31T00:01:06.012Z","updated_at":"2025-03-15T19:32:39.646Z","avatar_url":"https://github.com/ankitskvmdam.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# clean-jsdoc-theme\n\n[![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.3.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) [![license](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE)\n\u003cbr\u003e\n\n`clean-jsdoc-theme` enhances your JSDoc 3 or 4 documentation with a beautiful and responsive design. It offers a variety of customization options to tailor the look and feel to your preferences.\n\n## Key Features\n\n- **Widespread Device Compatibility:** `clean-jsdoc-theme` adapts seamlessly to desktops, laptops, tablets, and mobile devices, ensuring a smooth user experience across all platforms.\n- **Premium Aesthetics:** Choose between a sleek dark theme or a bright light theme, both designed to deliver a high-quality appearance for your documentation.\n- **Optimized File Size:** `clean-jsdoc-theme` automatically minifies the generated HTML files, reducing their overall size by several kilobytes without compromising functionality.\n- **Robust Search Functionality:** The built-in search feature allows users to quickly find specific information within your documentation, and it does so without adding extra weight to the output files.\n- **Regular Updates:** We actively maintain `clean-jsdoc-theme`, ensuring it remains up-to-date and compatible with the latest technologies.\n- **Exceptional Performance:** `clean-jsdoc-theme` prioritizes performance, delivering a fast and responsive user experience for your documentation consumers. You can view the [Lighthouse report](https://googlechrome.github.io/lighthouse/viewer/?psiurl=https%3A%2F%2Fankdev.me%2Fclean-jsdoc-theme%2Fv4%2Findex.html\u0026strategy=desktop\u0026category=performance\u0026category=accessibility\u0026category=best-practices\u0026category=seo\u0026category=pwa\u0026utm_source=lh-chrome-ext#) for a detailed performance analysis.\n- **Open Communication:** The `clean-jsdoc-theme` team acknowledges that continuous improvement is essential. We welcome feedback from the community, so feel free to share your suggestions, questions, or bug reports by creating an issue on [GitHub](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues).\n\n\n## Demo\n\n1. To view this theme, visit [https://ankdev.me/clean-jsdoc-theme/v4](https://ankdev.me/clean-jsdoc-theme/v4).\n\n2. If you want to see a demo repo to set up this theme,\n   visit [clean-jsdoc-theme-example](https://github.com/ankitskvmdam/clean-jsdoc-theme-example). This repo will guide\n   you step by step on how to set up JSDoc and `clean-jsdoc-theme` in your existing repo.\n\n## Screenshots\n\n![Dark theme](./example/screen-1.png)\n![Light theme](./example/screen-2.png)\n![Mobile View](./example/screen-3.png)\n![Search view](./example/screen-4.png)\n![Class page](./example/screen-5.png)\n![Code page](./example/screen-6.png)\n\n## Installation\n\n\u003e Note : you must have `node` and `npm` installed on your machine.\n\nIn a terminal, type :\n\n```bash\nnpm install clean-jsdoc-theme --save-dev\n# or\nyarn add clean-jsdoc-theme -D\n```\n\nIn your projects `package.json` file, add a script to generate the documentation using JSDoc :\n\n```json\n\"scripts\": {\n  \"generate-docs\": \"jsdoc --configure jsdoc.json --verbose\"\n}\n```\n\n\u003e Heads Up! In the above `generate_docs` script, the value of the `--configure` option is `jsdoc.json`. Make sure\n\u003e the `jsdoc.json` file exists as it contains the JSDoc configuration. If you have your JSDoc config in a different\n\u003e file,\n\u003e replace `jsdoc.json` with its name.\n\nIn your `jsdoc.json` file, add a template option to use `clean-jsdoc-theme` instead of the default JSDoc theme:\n\n```json\n\"opts\": {\n  \"template\": \"node_modules/clean-jsdoc-theme\"\n}\n```\n\nNow, run the previously added script to generate the documentation :\n\n```bash\nnpm run generate-docs\n```\n\nFor more information, look at the [clean-jsdoc-theme-example](https://github.com/ankitskvmdam/clean-jsdoc-theme-example)\nrepository.\n\n## Example JSDoc Config\n\n```json\n{\n    \"source\": {\n        \"include\": [\"lib\", \"package.json\", \"README.md\"],\n        \"includePattern\": \".js$\",\n        \"excludePattern\": \"(node_modules/|docs)\"\n    },\n    \"plugins\": [\"plugins/markdown\"],\n    \"opts\": {\n        \"encoding\": \"utf8\",\n        \"readme\": \"./README.md\",\n        \"destination\": \"docs/\",\n        \"recurse\": true,\n        \"verbose\": true,\n        \"template\": \"./node_modules/clean-jsdoc-theme\",\n        \"theme_opts\": {\n            \"default_theme\": \"dark\"\n        }\n    },\n    \"markdown\": {\n        \"hardwrap\": false,\n        \"idInHeadings\": true\n        // This is important for clean-jsdoc-theme, otherwise some features might not work.\n    }\n}\n```\n\n## Options\n\n### Set a default theme\n\nTo set the default theme, add the following in your JSDoc config file:\n\n```json\n\"theme_opts\": {\n  \"default_theme\": \"dark\" // \"light\", \"fallback-dark\", \"fallback-light\"\n}\n```\n\nIf you set default theme as `\"fallback-dark\"`, then `clean-jsdoc-theme` will try to detect user's preferred color scheme. If it will detect successfully then it will set user's preferred theme else fallback to dark theme.\n\nSame if you set default theme as `\"fallback-light\"`, it will try to detect user's preferred theme. If not then fallback to light theme.\n\n### Set base url\n\nTo set the base url, add the following in your JSDoc config file:\n\n```json\n\"theme_opts\": {\n  \"base_url\": \"https://ankdev.me/v4/\"\n}\n```\n\n\u003e Make sure to add a forward slash (`/`) at the end of the URL.\n\nThe default value of `base_url` is computed with the following code:\n\n```js\nconst path = document.location.pathname;\nconst baseURL = path.substr(0, path.lastIndexOf('/') + 1);\n```\n\n### Add favicon\n\nTo set a favicon, add the following in your JSDoc config file:\n\n```json\n\"theme_opts\": {\n  \"favicon\": \"path/to/img\"\n}\n```\n\nYou can use [`static_dir`](#add-static-dir) option to copy all you static files to output dir and use that path instead\nof `path/to/img`. This will not flatten the output file path, it will preserve the directory structure. If you want to\nflatten the output dir use jsdoc default [copy static files options](https://jsdoc.app/about-configuring-default-template.html)\n\n### Add homepage title\n\nTo add the title of the homepage use the `homepageTitle` property as follows:\n\n```json\n\"theme_opts\": {\n  \"homepageTitle\": \"Clean JSDoc theme\"\n}\n```\n\n### Add title\n\nBoth strings and HTML are accepted. Use HTML to overwrite the default HTML, and a string to set a plaintext title. One\nexample of this is below:\n\n```json\n\"theme_opts\": {\n  \"title\": \"\u003cimg src='path/to/img' class='my-custom-class'/\u003e\" // or \"title\": \"clean-jsodc-theme\"\n}\n```\n\nYou can use [`static_dir`](#add-static-dir) option to copy all you static files to output dir and use that path in place\nof `path/to/img`.\n\n### Add files list in homepage\n\nBy default `clean-jsdoc-theme` will not include the list of files in the homepage. If you want to add them the do the following\n\n```json\n\"theme_opts\": {\n  \"includeFilesListInHomepage\": true // by default it is false.\n}\n```\n\n\u003e 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\n\n### Add navbar menu\n\nTo render extra link(s) in navbar. It accepts an array of objects:\n\n```json\n\"theme_opts\": {\n  \"menu\": [\n    {\n      \"title\": \"Website\",\n      \"link\": \"https://ankdev.me/clean-jsdoc-theme/dark/\",\n      \"target\": \"_blank\",\n      \"class\": \"some-class\",\n      \"id\": \"some-id\"\n    },\n    {\n      // more if you want to.\n    }\n  ]\n}\n```\n\n`menu` is an array of objects. Each object has five properties, out of which two are required (`title` and `link`). If\nan object doesn't have the required properties, then you might expect an error.\n\n\u003cb\u003eProperties\u003c/b\u003e\n\n| name     | type     | required |\n| -------- | -------- | -------- |\n| `title`  | `string` | required |\n| `link`   | `string` | required |\n| `target` | `string` | optional |\n| `class`  | `string` | optional |\n| `id`     | `string` | optional |\n\n### Sections\n\nThere is also an option to add a meta tag to every generated HTML file. You can use the `meta` option to include a list\nof `meta` tags into `head`.\n\n```json\n\"theme_opts\": {\n  \"sections\": [\"Classes\", \"Modules\", \"Global\"] // Only three members will be in the sidebar.\n}\n```\n\n```js\n// SECTION_TYPE\n[\n    'Classes',\n    'Modules',\n    'Externals',\n    'Events',\n    'Namespaces',\n    'Mixins',\n    'Tutorials',\n    'Interfaces',\n    'Global',\n];\n```\n\n### Meta\n\nThere is also an option to add meta tag to every generated HTML file. You can use `meta` option to include a list\nof `meta` tags into `head`.\n\n```json\n\"theme_opts\": {\n  \"meta\": [\n    {\n      \"name\": \"author\",\n      \"content\": \"Ankit Kumar\"\n    },\n    {\n      \"name\": \"description\",\n      \"content\": \"Best Clean and minimal JSDoc 3 Template/Theme\"\n    }\n  ]\n}\n```\n\n`meta` is an array of objects. Each objects can have any valid combination\nof [HTML metadata attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#Attributes).\n\n### Search\n\nBy default, the search feature is enabled in the theme.\n\n\u003e Make sure you have added the `base_url` option as well, otherwise your search query might fail.\n\u003e\n\u003e If you want to disable the search feature, you can do the following:\n\n```json\n\"theme_opts\": {\n  \"search\": false\n}\n```\n\n**How does the search work?**\n\nIf the search feature is enabled, you'll see a `data` folder in the output. This `data` folder contains a JSON\ncalled `search.json`. There is a fetch request when user types anything in the search box. That means search data is\nonly loaded if user wants to search anything.\n\n### CodePen\n\n\u003e Note: currently, this feature is only enabled for the examples section.\n\n```json\n\"theme_opts\": {\n  \"codepen\": {\n    \"enable_for\": [\"examples\"],\n    \"options\": {\n      \"js_external\": \"https://code.jquery.com/jquery-3.6.0.min.js\",\n      \"js_pre_processor\": \"babel\"\n    }\n  }\n}\n```\n\n`options` can be any valid CodePen option. For more\nvisit: [Codepen Prefill options](https://blog.codepen.io/documentation/prefill/#all-the-json-options-0)\n\nIf you want to add some js in the beginning of your example then you can use `js` option.\n\n```json\n\"theme_opts\": {\n  \"codepen\": {\n    \"enable_for\": [\"examples\"],\n    \"options\": {\n      \"js_external\": \"https://code.jquery.com/jquery-3.6.0.min.js\",\n      \"js_pre_processor\": \"babel\"\n      \"js\": \"import Something from 'some-package'\"\n    }\n  }\n}\n```\n\nLet say you have an example as follows:\n\n```js\n/**\n * @example\n * let a = Something.fn()\n * console.log(a) // Return value of something\n */\nconst a;\n```\n\nIn codepen the above `@example` will look like:\n\n```js\nimport Something from 'some-package';\n\nlet a = Something.fn();\nconsole.log(a); // Return value of something\n```\n\n### Add static dir\n\nTo include static files:\n\n```json\n\"theme_opts\": {\n  \"static_dir\": [\"./static\"],\n}\n```\n\n### Add styles\n\nTo create custom style rules. Example:\n\n```json\n\"theme_opts\": {\n  \"create_style\": \".sidebar-title { font-size: 2rem }\"\n}\n```\n\n### Add style paths\n\nUse this option to add third party css library. If you want to add your own custom css file then consider\nusing [Add custom css files](#add-custom-css-files)\n\n\u003e Note: you have to pass an array of objects. Each object key will be an attribute inside the generated style tag.\n\nExample:\n\n```json\n\"add_style_path\": [\n  {\n    \"href\": \"https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta1/dist/css/bootstrap.min.css\",\n    \"integrity\": \"sha384-giJF6kkoqNQ00vy+HMDP7azOuL0xtbfIcaT9wjKHr8RbDVddVHyTfAAsrekwKmP1\",\n    \"crossorigin\": \"anonymous\"\n  }\n],\n```\n\n### Add custom css files\n\nTo include css files. Example:\n\n```json\n\"theme_opts\": {\n  \"include_css\": [\"./static/index.css\", \"./src/docs/index.css\"]\n}\n```\n\n\u003e Note: you are not required to manually copy file to output dir.\n\nIt will include the css files to the output dir and also attach a link tag to the html pointing to the included css\nfile.\n\n### Add scripts\n\nIf you wish to incorporate JavaScript functions that execute when a user accesses a webpage, you can utilize the add_scripts option for this purpose. For instance, suppose you want to display a notification dialog when a user visits the webpage located at https://place-where-my-docs-are/SomeClass.html. You want to notify users that they should refrain from utilizing this class. To accomplish this, you can proceed as follows:\n\n```json\n\"theme_opts\": {\n  \"add_scripts\": \"function showAlert(){ if (window.location.pathname === '/SomeClass.html') { alert('Do not use this class') } } showAlert();\",\n}\n```\n\nWriting js code like above can get tricky and complex. You can consider `include_js`.\n\n### Add script paths\n\nUse this option to add third party js library. If you want to add your own custom script file then consider\nusing [Add custom script files](#add-custom-script-files)\n\n\u003e Note: you have to pass an array of objects, and object keys are actually the attributes which you want in you script\n\u003e tag.\n\nExample:\n\n```json\n\"add_script_path\": [\n  {\n    \"href\": \"https://code.jquery.com/jquery-3.5.1.js\",\n    \"integrity\": \"sha256-QWo7LDvxbWT2tbbQ97B53yJnYU3WhH/C8ycbRAkjPDc=\",\n    \"crossorigin\": \"anonymous\"\n  }\n],\n```\n\nThis will copy the static folder to the output dir.\n\n\u003e Note: if the directory doesn't exist then you may get an error. Also, directory is relative to your jsdoc config file.\n\nThis will not flatten the directory. Directory structure will be kept as it is.\n\n### Add custom script files\n\nIf you wish to run some local/custom javascript then you can include them via `include_js`.\n\nLets say you want to show some custom message depending on url. You can create a js file as follows:\n\n```js\n// static/showAlert.js\nfunction showCustomAlertMessage() {\n    const pathname = window.location.pathname;\n\n    switch (pathname) {\n        case '/SomeClass.html':\n            return alert(\"Please don't use this class\");\n        case '/OtherPage.html':\n            return alert('Wonderful!');\n        default:\n            return;\n    }\n}\n\nshowCustomAlert();\n```\n\nAssuming the above js file is stored in `./static/showAlert.js`. To include you can do:\n\n```json\n\"theme_opts\": {\n  \"include_js\": [\"./static/showAlert.js\"]\n}\n```\n\n\u003e Note: you are not required to manually copy file to output dir.\n\nIt will include the js files to the output dir and also attach a script tag to the html pointing to the included js\nfile.\n\nIf you want to add some script for some pages then you can do the following:\n\n```json\n\"include_js\": [\n    \"./demo/src/assets/script.js\",\n    {\n        \"filepath\": \"./demo/src/assets/random.js\",\n        \"targets\": [\n            \"MyClass\",\n            \"tutorial-MyClassTutorial\"\n        ]\n    }\n],\n```\n\nHere target is the name of the generated html file (don't include `.html`).\n\nThe above config will add `./demo/src/assets/script.js` to all the generated html files. However, it will\nadd `./demo/src/assets/random.js` only to `MyClass.html` and `tutorial-MyClassTutorial.html` files.\n\nThe file name of the generated html generally follows the following convention:\n\n-   Class: class's name + `.html`. Ex `Alive.html`\n-   Module: `module-` + module's name + `.html`. Ex: `module-SqlJs.html`\n-   Tutorials: `tutorial-` + tutorial's filename + `.html`\n\nIf you are not sure about the target name, then generate html for the first time, then look at the urls.\n\n### To ignore sorting\n\nTo ignore the sorting of members/methods/event in the page. If it is `false` then the order of\nmembers/methods/events will be in the order they are in code/source.\n\n```json\n\"theme_opts\": {\n  \"sort\": false\n}\n```\n\n### Footer\n\n```json\n\"theme_opts\": {\n  \"footer\": \"This is footer\" // or \u003cdiv class=\"footer-wrapper\"\u003eThis is a footer \u003c/div\u003e\n}\n```\n\n### To exclude inherited\n\nTo exclude inherited symbols. Example:\n\n```json\n\"exclude_inherited\": true\n```\n\nThis will remove all symbols (members, methods ...) that come from inherited parents.\n\n### To remove styled applied to scrollbar\n\nBy default `clean-jsdoc-theme` applies some styles to browser's scroll bar. However if you want to remove this style do the following\n\n```json\n{\n    \"theme_opts\": {\n        \"shouldRemoveScrollbarStyle\": false\n    }\n}\n```\n\nThis will remove all symbols (members, methods ...) that come from inherited parents.\n\n## Cheat sheet\n\n| name                         | default                                                                                                      | use case                                                                   | expected value(s)                                          |\n| ---------------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | ---------------------------------------------------------- |\n| `default_theme`              | `\"dark\"`                                                                                                     | To set the default theme                                                   | `\"light\", \"dark\"`, `\"fallback-light\"` or `\"fallback-dark\"` |\n| `homepageTitle`              | \"Home\"                                                                                                       | To set the title of homepage. This will update HTML `\u003ctitle\u003e`.             | `string`                                                   |\n| `title`                      | `null`                                                                                                       | To set the title of the sidebar.                                                           | `HTML` or `string`                                         |\n| `base_url`                   | `/`                                                                                                          | To set the base URL                                                        | `string`                                                   |\n| `menu`                       | `null`                                                                                                       | To render extra link in navbar                                             | Array of Object(s)                                         |\n| `meta`                       | `null`                                                                                                       | Meta tag attributes                                                        | Array of Object(s)                                         |\n| `search`                     | `true`                                                                                                       | To render search or not                                                    | `true` or `false`                                          |\n| `codepen`                    | `{}`                                                                                                         | To open code in codepen                                                    | `Object`                                                   |\n| `static_dir`                 | `null`                                                                                                       | To include static dir                                                      | Array of string                                            |\n| `create_style`               | `null`                                                                                                       | To create custom style rules                                               | `string`                                                   |\n| `add_style_path`             | `null`                                                                                                       | To add external css libraries/files                                        | Array of Object(s)                                         |\n| `include_css`                | `null`                                                                                                       | To include css files                                                       | Array of string                                            |\n| `add_scripts`                | `null`                                                                                                       | To create custom script                                                    | `string`                                                   |\n| `add_script_path`            | `null`                                                                                                       | To add external js libraries/files                                         | Array of Object(s)                                         |\n| `include_js`                 | `null`                                                                                                       | To include js files                                                        | `string`                                                   |\n| `footer`                     | `null`                                                                                                       | To render footer                                                           | `HTML` or `string`                                         |\n| `exclude_inherited`          | `false`                                                                                                      | To exclude inherited symbols                                               | `boolean`                                                  |\n| `sections`                   | `[\"Modules\", \"Classes\", \"Externals\", \"Events\", \"Namespaces\", \"Mixins\", \"Tutorials\", \"Interfaces\", \"Global\"]` | To order navbar/sidebar sections or to hide/remove navbar/sidebar sections | `Array\u003cSECTION_TYPE\u003e`                                      |\n| `displayModuleHeader`        | `false`                                                                                                      | If you want the module name to appear on its page                          | `boolean`                                                  |\n| `includeFilesListInHomepage` | `false`                                                                                                      | If you want to add or remove the list of files in homepage                 | `boolean`                                                  |\n| `sort`                       | `true`                                                                                                       | To sort the output members/methods/events                                  | `boolean`                                                  |\n| `shouldRemoveScrollbarStyle` | `false`                                                                                                      | To remove styles applied to browser's scrollbar                            | `boolean`                                                  |\n\nDon't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.\n\n```json\n\"markdown\": {\n  \"idInHeadings\": true // This is important for clean-jsdoc-theme, otherwise some features might not work.\n}\n```\n\n## Changelog\n\nChangelog is moved\nto [https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md)\n\n## Developing\n\nBefore starting please go through\nour [contributing guide](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CONTRIBUTING.md).\n\n```bash\ngit clone https://github.com/ankitskvmdam/clean-jsdoc-theme.git\ncd clean-jsdoc-theme\nnpm install\nnpm install jsdoc --no-save\nnpm run build\n```\n\n`npm run build` will generate files in output folder.\n\n## Contributors\n\n\u003ca href=\"https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=ankitskvmdam/clean-jsdoc-theme\" alt=\"clean-jsdoc-contributors\" /\u003e\n\u003c/a\u003e\n\n## Thanks\n\nThanks to [fuse.js](https://fusejs.io/), [hljs](https://highlightjs.org/),[tippy.js](https://tippyjs.bootcss.com/), and\nall awesome contributors.\n\n## Contact\n\nIf you like my work, then give me\na \u003ca href=\"https://github.com/ankitskvmdam/clean-jsdoc-theme\" data-icon=\"octicon-star\" aria-label=\"Star ankitskvmdam/clean-jsdoc-theme on GitHub\"\u003e\nstar\u003c/a\u003e.\n\nMail me at: \u003ca href=\"mailto:hello@ankdev.me\"\u003ehello@ankdev.me\u003c/a\u003e \u003cbr\u003e\n\n## License\n\nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitskvmdam%2Fclean-jsdoc-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankitskvmdam%2Fclean-jsdoc-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitskvmdam%2Fclean-jsdoc-theme/lists"}