Update to TypeDoc 0.22 / 0.23

mapeditor / tiled

Flexible level editor

https://www.mapeditor.org/

Other

11.21k stars 1.76k forks source link

Update to TypeDoc 0.22 / 0.23 #3592

Open bjorn opened 1 year ago

bjorn commented 1 year ago

Currently the scripting documentation on the website is still driven by TypeDoc 0.21, since its theming is based on customizing Handlebars files. To update to TypeDoc 0.22 and beyond, we need to redo the customization using a JSX theme.

References:

https://typedoc.org/guides/changelog/#v0.22.0-(2021-09-10)
https://github.com/TypeStrong/typedoc/blob/v0.22.0/internal-docs/custom-themes.md
https://github.com/Gerrit0/typedoc-custom-theme-demo

TypeDoc 0.21 custom theme:

https://github.com/mapeditor/tiled/commits/gh-pages/docs/typedoc_theme

bjorn commented 1 year ago

Related: sphinx-js could be a nice way to bring the JS API back into the manual based on the TypeScript declarations at index.d.ts, which would be an alternative to redoing the theme customization. However, the sphinx-js documentation notes that "TypeDoc 0.15.0" is known to work, so it may not actually help with updating to a newer version of TypeDoc.