Skip to content

Commit

Permalink
Link to source code on GitHub from documentation
Browse files Browse the repository at this point in the history
Instead of including the entire source code in the documentation.
  • Loading branch information
twiss committed Feb 9, 2021
1 parent 0c5598a commit defa128
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .jsdocrc.js
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 3 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit defa128

Please sign in to comment.