mirror of
https://github.com/pulsar-edit/pulsar.git
synced 2024-10-27 03:32:44 +03:00
Update Documentation CI
This commit is contained in:
commit
f3755d71fc
1
.github/workflows/documentation.yml
vendored
1
.github/workflows/documentation.yml
vendored
@ -3,6 +3,7 @@ name: Documentation
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
workflow_dispatch:
|
||||
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
11
docs/.jsdoc.json
Normal file
11
docs/.jsdoc.json
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"recurseDepth": 10,
|
||||
"source": {
|
||||
"include": ["src", "packages"],
|
||||
"exclude": ["node_modules"],
|
||||
"excludePattern": "((^|\\/|\\\\)_|node_modules)"
|
||||
},
|
||||
"opts": {
|
||||
"recurse": true
|
||||
}
|
||||
}
|
@ -273,8 +273,8 @@
|
||||
"build:apm": "cd ppm && yarn install",
|
||||
"start": "electron --no-sandbox --enable-logging . -f",
|
||||
"dist": "node script/electron-builder.js",
|
||||
"js-docs": "jsdoc2md ./src/**/*.js ./packages/**/*.js > ./docs/Pulsar-API-Documentation.md",
|
||||
"private-js-docs": "jsdoc2md --private ./src/**/*.js ./packages/**/*.js > ./docs/Source-Code-Documentation.md"
|
||||
"js-docs": "jsdoc2md --files src --configure docs/.jsdoc.json > ./docs/Pulsar-API-Documentation.md",
|
||||
"private-js-docs": "jsdoc2md --private --files src --configure docs/.jsdoc.json > ./docs/Source-Code-Documentation.md"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@electron/notarize": "^1.2.3",
|
||||
|
Loading…
Reference in New Issue
Block a user