ECMAScript icon indicating copy to clipboard operation
ECMAScript copied to clipboard

Adding doc generation using typedoc.

Open Flux159 opened this issue 4 years ago • 3 comments

This pull request adds a script in misc/package.json in order to generate docs into a misc/docs folder.

Run the following to create a docs folder:

cd misc
yarn
yarn generatedocs

The folder itself is gitignored, in order to generate Github Pages hosted documentation, you want to create a new empty gh-pages branch, move the docs folder into the root of that branch, then update a few configuration files for github pages (specifically a .nojekyll file and adding a _config.yml in the gh-pages branch like https://github.com/Flux159/ECMAScript/commits/gh-pages)

The reason I didn't move this into the Github action to automate is because it requires work from the repository owner to setup push permissions via Github Actions, so this is just a manual way of generating docs for now.

Flux159 avatar Oct 10 '20 20:10 Flux159

References #65

Flux159 avatar Oct 10 '20 20:10 Flux159

Is misc/yarn.lock is required?

Geequlim avatar Nov 21 '20 03:11 Geequlim

Is misc/yarn.lock is required?

Technically it should be committed to have more deterministic package installs. I don't think it matters too much in this case, but it's fairly standard to know if deps end up changing.

Flux159 avatar Nov 25 '20 21:11 Flux159

@Geequlim Thoughts about closing this since it has not been updated in 3 years?

If there's any interest, I think the proposal is still doable.

fire avatar Apr 23 '23 15:04 fire

Closing due to lack of response. Feel free to submit a new pr.

fire avatar Jun 17 '23 01:06 fire