Create GitHub Action to automate building GitHub Pages documentation #9
Labels
enhancement
New feature or request
good first issue
Good for newcomers
help wanted
Extra attention is needed
Is your feature request related to a problem? Please describe.
We should have a GitHub Action created such that we do not need to manually update the website and wiki every time a change is made to the JSDoc source.
Describe the solution you'd like
Considering there are numerous different libraries created for the sole purpose of converting JSDoc to markdown and visa versa, we could use the following steps:
class/*.js
intoclass/*.md
(removeclass/*.js
afterwards)utils/*.js
intoutils/*.md
(removeutils/*.js
afterwards)CODE_OF_CONDUCT.md
,SECURITY.md
, andCONTRIBUTING.md
into.
_config.yml
pages
branchclass/*.md
toclass:-*.md
andutils/*.md
toutils:-*.md
Describe alternatives you've considered
Well, we could manually convert them like before, but that would be incredibly inefficient.
Additional context
N/A
The text was updated successfully, but these errors were encountered: