Link to source code on GitHub from documentation
Instead of including the entire source code in the documentation.
This commit is contained in:
parent
0c5598a0fc
commit
defa1283cb
10
.jsdocrc.js
10
.jsdocrc.js
|
@ -1,6 +1,16 @@
|
|||
const pkg = require('./package.json');
|
||||
|
||||
module.exports = {
|
||||
plugins: ['plugins/markdown'],
|
||||
markdown: {
|
||||
idInHeadings: true
|
||||
},
|
||||
templates: {
|
||||
default: {
|
||||
outputSourceFiles: false,
|
||||
externalSourceLinks: {
|
||||
urlPrefix: `${pkg.repository.url}/blob/v${pkg.version}/src/`
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
5
package-lock.json
generated
5
package-lock.json
generated
|
@ -2164,9 +2164,8 @@
|
|||
}
|
||||
},
|
||||
"jsdoc": {
|
||||
"version": "3.6.4",
|
||||
"resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.4.tgz",
|
||||
"integrity": "sha512-3G9d37VHv7MFdheviDCjUfQoIjdv4TC5zTTf5G9VODLtOnVS6La1eoYBDlbWfsRT3/Xo+j2MIqki2EV12BZfwA==",
|
||||
"version": "github:openpgpjs/jsdoc#0f1816eb4553856647b4ca9561b9307b11ec4f9e",
|
||||
"from": "github:openpgpjs/jsdoc#0f1816eb4553856647b4ca9561b9307b11ec4f9e",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@babel/parser": "^7.9.4",
|
||||
|
|
|
@ -59,7 +59,7 @@
|
|||
"eslint-plugin-import": "^2.8.0",
|
||||
"hash.js": "^1.1.3",
|
||||
"http-server": "^0.12.3",
|
||||
"jsdoc": "^3.6.4",
|
||||
"jsdoc": "github:openpgpjs/jsdoc#0f1816eb4553856647b4ca9561b9307b11ec4f9e",
|
||||
"mocha": "^5.0.0",
|
||||
"nyc": "^14.1.1",
|
||||
"pako": "^1.0.6",
|
||||
|
|
Loading…
Reference in New Issue
Block a user