https://github.com/wiris/mathtype-integration-jsdoc-theme
MathType Integration JSDoc Theme
https://github.com/wiris/mathtype-integration-jsdoc-theme
Last synced: 2 months ago
JSON representation
MathType Integration JSDoc Theme
- Host: GitHub
- URL: https://github.com/wiris/mathtype-integration-jsdoc-theme
- Owner: wiris
- License: other
- Created: 2019-03-29T09:40:57.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T19:48:30.000Z (over 2 years ago)
- Last Synced: 2025-01-27T22:46:01.517Z (4 months ago)
- Language: JavaScript
- Size: 209 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MathType Integration JSDoc theme
JSDoc theme for [MathType JavaScript Integration API](https://www.npmjs.com/package/@wiris/mathtype-html-integration-devkit).
Forked from [Bookshelf](https://github.com/bookshelf/bookshelf-jsdoc-theme).
## Install Instructions
Clone the [MathType Javascript Integration API](https://www.npmjs.com/package/@wiris/mathtype-html-integration-devkit) from the MathType web repository:
```bash
$ git clone https://github.com/wiris/html-integrations
$ cd packages/mathtype-html-integration-devkit
```
Then, install `npm` dependencies:
```bash
$ npm install
```
## Usage
Run this commands to generate the source files of the documentation site:
```bash
$ npm run build-docs
```
The source code of the documentation site is generated on the `/out` folder.
### Styles
Stlyes must be compiled if edited:
```bash
$ npm run styles
```
### Node.js Dependency
In your projects `package.json` file add a generate script:
```json
"script": {
"generate-docs": "jsdoc --configure .jsdoc.json --verbose"
}
### Example JSDoc Config
```js
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": false,
"monospaceLinks": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "path/to/mathtype-integration-jsdoc-theme",
"whitelist": ["Optional", "List", "Of", "Top", "Level", "Classes"],
"changelog": "./path-to/CHANGELOG.md",
"title": ""
}
}
```
## Releases
All notable changes to this project are documented in the [CHANGELOG.md](CHANGES.md) file.
## License
Licensed under the GNU 3.0 General Public License.