Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
clean-jsdoc-theme
Advanced tools
clean-jsdoc-theme - npm Package Compare versions
Comparing version 3.1.1 to 3.1.2
| ## Change Log | ||
| ### In version 3.1.2 | ||
| ### New | ||
| 1. Change ham animation. | ||
| ### Others | ||
| 1. Update readme file. | ||
| ### In version 3.1.0 | ||
@@ -4,0 +14,0 @@ |
@@ -30,12 +30,10 @@ { | ||
| { | ||
| "title": "test", | ||
| "id": "test-id" | ||
| "title": "Github", | ||
| "id": "github", | ||
| "link": "https://github.com/ankitskvmdam/clean-jsdoc-theme" | ||
| }, | ||
| { | ||
| "title": "test2", | ||
| "id": "test-id" | ||
| }, | ||
| { | ||
| "title": "test3", | ||
| "id": "test-id" | ||
| "title": "npm", | ||
| "id": "npm", | ||
| "link": "https://www.npmjs.com/package/clean-jsdoc-theme" | ||
| } | ||
@@ -42,0 +40,0 @@ ] |
| { | ||
| "name": "clean-jsdoc-theme", | ||
| "version": "3.1.1", | ||
| "version": "3.1.2", | ||
| "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", |
@@ -1,43 +0,13 @@ | ||
| # clean-jsdoc-theme | ||
| <hr> | ||
| <h1 align="center">clean-jsdoc-theme</h1> | ||
| <p align=center><i align="center">A beautiful, responsive, customizable theme for JSDoc</i></p> | ||
| <hr> | ||
| [](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/issues?q=is%3Aissue+is%3Aclosed) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [](https://www.npmjs.com/package/clean-jsdoc-theme) [](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) [](https://ankdev.me/clean-jsdoc-theme/index.html) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT_HINDI.md) [](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CODE_OF_CONDUCT.md) | ||
| [](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> | ||
| 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 highly customizable theme (for more look below in <a href="#features">feature section</a>).<br> | ||
| Feel free to raise <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme/issues">issues</a>. | ||
| Clean-jsdoc-theme is a beautifully crafted theme/template for JSDoc 3. This theme/template looks and feels like a premium theme/template as it's mobile responsive and also highly customizable. For more options [look below at the options section](#options). | ||
| ## Table of content | ||
| For any suggestions, questions or bugs, feel free to create an <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme/issues">issue</a> in this repo. | ||
| - [Demo](#demo) | ||
| - [Screenshot](#screenshot) | ||
| - [Technologies Used](#technologies-used) | ||
| - [Motivation](#motivation) | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [Nodejs Dependencies](#nodejs-dependency) | ||
| - [Example Jsdoc Config](#example-jsdoc-config) | ||
| - [Features](#features) | ||
| - [theme](#theme--light--dark) | ||
| - [title](#title-string--html) | ||
| - [filter](#filter-boolean) | ||
| - [menu](#menu-array) | ||
| - [meta](#meta-array) | ||
| - [search](#search-) | ||
| - [overlay_scrollbar](#overlay_scrollbar-) | ||
| - [create_style](#create_style-string) | ||
| - [add_scripts](#add_scripts-string) | ||
| - [add_style_path](#add_style_path-array) | ||
| - [add_script_path](#add_script_path-array) | ||
| - [footer](#footer-string--html) | ||
| - [static_dir](#static_dir-arraystring) | ||
| - [include_css](#include_css-arraystring) | ||
| - [include_js](#include_js-arraystring) | ||
| - [Example](#example-theme_opts) | ||
| - [Cheat sheet](#cheat-sheet) | ||
| - [Changelog](#changelog) | ||
| - [Developing](#developing) | ||
| - [Contributors](#contributors) | ||
| - [Contact](#contact) | ||
| - [License](#license) | ||
| ## Demo | ||
@@ -57,15 +27,14 @@ | ||
| ## Technologies Used | ||
| ## Libraries Used | ||
| 1. Fuse.js - Fuse.js is a powerful, lightweight fuzzy-search library, with zero dependencies. [Learn More](https://fusejs.io/) | ||
| 1. Overlay Scrollbars - A javascript scrollbar plugin which hides native scrollbars, provides | ||
| custom styleable overlay scrollbars and keeps the native functionality and feeling. [Learn More](https://kingsora.github.io/OverlayScrollbars/#!overview) | ||
| 1. Nodejs | ||
| 1. [Fuse.js](https://fusejs.io/) - Fuse.js is a powerful, lightweight fuzzy-search library, with zero dependencies. | ||
| 1. [Overlay Scrollbars](https://kingsora.github.io/OverlayScrollbars/#!overview) - A javascript scrollbar plugin which hides native scrollbars, provides | ||
| custom styleable overlay scrollbars and keeps the native functionality and feeling of native scrollbars. | ||
| ## Motivation | ||
| At the time when I was new to js documentation and jsdoc, it was hard for me to find any theme for jsdoc which is highly customizable or regularly maintaining. Also, the search used in other themes is not that advanced. | ||
| To tackle these I created this project. I am actively listening to the community and try to make the changes as soon as possible. | ||
| When I was new to JavaScript documentation and [JSDoc](https://jsdoc.app/), it was hard for me to find a theme for JSDoc which was highly customizable or regularly maintained. Features that these lacked included responsiveness, a working search bar, and customization. | ||
| To tackle these problems I created this project, an easy to use, responsive theme for JSDoc. I am actively working on this project and I try to make changes to the project frequently to make sure it's up to date, and suggestions and bugs are fixed. | ||
| ## Install | ||
| ## Installation | ||
@@ -82,3 +51,3 @@ > Note you must have `npm` installed on your machine. | ||
| Clone repository to your designated jsdoc template directory, then | ||
| Clone repository to your designated JSDoc template directory, then run the following command: | ||
@@ -91,3 +60,3 @@ ```bash | ||
| In your projects package.json file add a generate script | ||
| In your projects `package.json` file add a generate script | ||
@@ -134,5 +103,5 @@ ```json | ||
| ## Features | ||
| ## Options | ||
| You can pass an object called `theme_opts` under `opts` for more options. | ||
| To use custom options (such as light and dark modes), pass an object called `theme_opts` in your config file under `opts`. | ||
@@ -146,3 +115,3 @@ ### `theme : "light" | "dark"` | ||
| To set the title to the navbar. String and HTMl is both accepted. Use HTML to overwrite the default HTML. You can do something like this | ||
| This option sets the title of the document in the navbar. Both strings and HTML are accepted; use HTML to overwrite the default HTML, and a string to set a plaintext title. One example of this is below: | ||
@@ -157,7 +126,7 @@ ```json | ||
| This is deprecated. This is used to turn the navbar image to white for better contrast. | ||
| This option is now deprecated, it was used to change the navbar image to white for better contrast. | ||
| ### `menu: Array<{}>` | ||
| To render extra link(s) in navbar. It accepts an array of objects example: | ||
| This options allows rendering of extra link(s) in navbar to the side of the documentation. It accepts an array of objects, such as in the following example example: | ||
@@ -354,3 +323,3 @@ ```json | ||
| It will include the js files to the output dir and also attach a link tag to the html pointing to the included js file. | ||
| It will include the js files to the output dir and also attach a script tag to the html pointing to the included js file. | ||
@@ -357,0 +326,0 @@ ### Example `theme_opts` |
Sorry, the diff of this file is not supported yet
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.18%
652864
- Number of package files
- increased by1.67%
61
Worsened metrics
- Lines of code
- decreased by-0.08%
2529
- Number of lines in readme file
- decreased by-6.62%
437
No dependency changes