Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move from ESDoc to TypeDoc #26

Merged
merged 5 commits into from Dec 29, 2021
Merged

Move from ESDoc to TypeDoc #26

merged 5 commits into from Dec 29, 2021

Conversation

dsevillamartin
Copy link
Member

@dsevillamartin dsevillamartin commented Dec 28, 2021

ESDoc has been failing for a while now. The plugins that make it support ECMAScript and other stuff barely work, if at all, and the multiple "updated" packages that exist out there all have their own issues.

Thus, it makes sense to switch away from it. There's not that many alternatives that look like they'd work for us, and I think I prefer ESDoc (when it used to work for us) over all of them. However, I believe I've found a pretty good alternative that'll work - https://typedoc.org/

Full-page screenshots

image
image
image

Building Locally

Comment out the last line in scripts/_vars.sh and run ./scripts/build-js.sh. Should work.

@davwheat
Copy link
Member

yarn set version stable
yarn

pls :))

typedoc.json Outdated Show resolved Hide resolved
Co-authored-by: David Wheatley <hi@davwheat.dev>
@dsevillamartin
Copy link
Member Author

@davwheat Am using npx and don't want to complicate this disaster further, that's why I want to stay with npm.

@davwheat
Copy link
Member

You can switch to yarn dlx, which does the same as npx.

@dsevillamartin
Copy link
Member Author

Will not be switching to Yarn as yarn dlx requires extra config & loads TypeDoc twice due to plugins. It's simpler to stay with NPM.

I believe this is ready for merge now @davwheat

@dsevillamartin dsevillamartin merged commit 4356ea9 into master Dec 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants