Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added JSDoc #1782

Merged
merged 42 commits into from Jun 27, 2020
Merged
Show file tree
Hide file tree
Changes from 39 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
9113978
Added JSDoc dependencies and config
RunDevelopment Feb 28, 2019
83c8a05
Documented Prism Core
RunDevelopment Feb 28, 2019
30c862d
Generated doc
RunDevelopment Feb 28, 2019
a310f42
Merge branch 'master' into jsdoc
RunDevelopment Feb 28, 2019
56f781a
New .doc.js
RunDevelopment Feb 28, 2019
b7f5a90
Better doc generation + removed generation date
RunDevelopment Feb 28, 2019
6b67445
Removes fonts which the theme we use doesn't need
RunDevelopment Feb 28, 2019
de977c5
'docs' is now part of gulp 'default'
RunDevelopment Feb 28, 2019
9e0e5cc
Rebuilt Prism
RunDevelopment Feb 28, 2019
d22fa62
Resolved conflict
RunDevelopment Mar 1, 2019
334a29a
Added Prism.Token doc
RunDevelopment Mar 1, 2019
4b658dd
Resolved conflict
RunDevelopment Mar 2, 2019
5899486
Resolved conflict + better jsdoc file managment
RunDevelopment Mar 2, 2019
6ac3ee8
Improvements
RunDevelopment Mar 4, 2019
72b5e95
Resolved conflict
RunDevelopment Mar 8, 2019
0129f21
Used TS style generics
RunDevelopment Mar 8, 2019
67d3d78
Updated doc
RunDevelopment Mar 8, 2019
396fa50
Simplified some array doc
RunDevelopment Mar 8, 2019
177f3b9
Removed more junk
RunDevelopment Mar 8, 2019
e625f15
Resolved conflict
RunDevelopment Mar 10, 2019
f7d98ea
Resolved conflict
RunDevelopment Mar 14, 2019
b8413ca
Resolved conflicts
RunDevelopment May 25, 2019
e016d9f
Use del instead of gulp-clean
RunDevelopment May 25, 2019
0f054d1
Dopped Node 6
RunDevelopment May 25, 2019
996d4e3
Resolved conflict
RunDevelopment Jun 26, 2020
fe59d05
Improvements
RunDevelopment Jun 26, 2020
34356c1
Rebuild
RunDevelopment Jun 26, 2020
843ebca
Resolved conflicts
RunDevelopment Jun 26, 2020
a7dd6dd
Styling
RunDevelopment Jun 26, 2020
e761d39
Merge branch 'master' into jsdoc
RunDevelopment Jun 26, 2020
9a80da3
New npm task + minor changes
RunDevelopment Jun 26, 2020
8c27f06
Fixed links
RunDevelopment Jun 26, 2020
cc250c5
New theme + improvements
RunDevelopment Jun 27, 2020
d1644dd
Some more comments
RunDevelopment Jun 27, 2020
7558f36
More documentation
RunDevelopment Jun 27, 2020
fc0b18d
Better explained example
RunDevelopment Jun 27, 2020
324b680
Merge branch 'master' into jsdoc
RunDevelopment Jun 27, 2020
dfe187a
Rebuild
RunDevelopment Jun 27, 2020
87ffea9
Added comment for control flow hack
RunDevelopment Jun 27, 2020
14009ad
Make docs part of the default task
RunDevelopment Jun 27, 2020
3bf75c2
Link to new doc
RunDevelopment Jun 27, 2020
9c9af76
Narrowed token type
RunDevelopment Jun 27, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 67 additions & 0 deletions .jsdoc.json
@@ -0,0 +1,67 @@
{
"plugins": [
"plugins/markdown",
"./gulpfile.js/docs.js"
],
"opts": {
"destination": "./docs",
"encoding": "utf8",
"template": "./node_modules/docdash",
"verbose": true,
"access": [
"public",
"protected"
]
},
"recurseDepth": 10,
"source": {
"includePattern": "\\.js$",
"excludePattern": "\\.min\\.js$"
},
"tags": {
"allowUnknownTags": true,
"dictionaries": [
"jsdoc",
"closure"
]
},
"templates": {
"cleverLinks": true,
"monospaceLinks": true,
"default": {
"includeDate": false
}
},
"docdash": {
"static": true,
"sort": true,
"search": true,
"collapse": false,
"wrap": false,
"typedefs": true,
"private": false,
"scripts": [
"styles/overwrites.css"
],
"openGraph": {
"title": "Prism generated API documentation",
"type": "website",
"image": "/logo.svg",
"site_name": "Prism",
"url": "https://prismjs.com"
},
"menu": {
"PrismJS": {
"href": "https://prismjs.com",
"class": "menu-item",
"id": "website_link"
},
"GitHub": {
"href": "https://github.com/PrismJS/prism",
"target": "_blank",
"class": "menu-item",
"id": "github_link"
}
}
}
}