pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-10-27 03:32:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Documentation CI

Browse Source
This commit is contained in:
Spiker985 2023-02-25 16:44:26 -05:00 committed by GitHub
commit f3755d71fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/documentation.yml vendored
View File

@ -3,6 +3,7 @@ name: Documentation
on:
push:
branches: [ "master" ]
workflow_dispatch:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

11
docs/.jsdoc.json Normal file
View File

@ -0,0 +1,11 @@
{
"recurseDepth": 10,
"source": {
"include": ["src", "packages"],
"exclude": ["node_modules"],
"excludePattern": "((^|\\/|\\\\)_|node_modules)"
},
"opts": {
"recurse": true
}
}

4
package.json
View File

@ -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",