Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

Commit

Permalink
Introduce docdash + jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ray Chen committed Jun 1, 2019
1 parent c293dda commit aeffbea
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 7 deletions.
49 changes: 49 additions & 0 deletions jsdoc.json
@@ -0,0 +1,49 @@
{
"tags": {
"allowUnknownTags": ["category"]
},
"source": {
"include": ["./src"],
"includePattern": ".js",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"opts": {
"readme": "README.md",
"template": "node_modules/docdash",
"destination": "docs/",
"recurse": true,
"verbose": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
},
"docdash": {
"sort": true,
"openGraph": {
"title": "Panolens",
"type": "website",
"image": "https://repository-images.githubusercontent.com/46604802/33c10480-7d64-11e9-97d8-f45a9169911c.png",
"site_name": "Panolens",
"url": "https://pchen66.github.io/Panolens/"
},
"meta": {
"title": "Panolens",
"description": "Panolens.js is an event-driven and WebGL based panorama viewer. Lightweight and flexible.",
"keyword": "panorama, 3d, 360, webgl, threejs"
},
"search": true,
"collapse": true,
"menu":{
"Github":{
"href":"https://github.com/pchen66/panolens.js",
"target":"_blank",
"class":"menu-item",
"id":"repository"
}
}
}
}
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 9 additions & 1 deletion package.json
Expand Up @@ -42,6 +42,14 @@
"error",
4
],
"spaced-comment": [
"error",
"always"
],
"multiline-comment-style": [
"error",
"starred-block"
],
"linebreak-style": [
"error",
"unix"
Expand Down Expand Up @@ -76,8 +84,8 @@
"devDependencies": {
"@tweenjs/tween.js": "^17.4.0",
"ava": "^1.4.1",
"better-docs": "^1.1.6",
"concurrently": "^4.1.0",
"docdash": "^1.1.1",
"eslint": "^5.16.0",
"google-closure-compiler": "^20190513.0.0",
"http-server": "^0.11.1",
Expand Down

0 comments on commit aeffbea

Please sign in to comment.