Update to TypeDoc 0.22 / 0.23 · mapeditor/tiled#3592

2023-02-28T14:15:51.000Z

Currently the [scripting documentation](https://www.mapeditor.org/docs/scripting/) 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

(2 comments) (0 reactions) (0 assignees)C++ (10,413 stars) (1,708 forks)batch import

help wantedwebsite

説明

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:

TypeDoc 0.21 custom theme:

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

コントリビューターガイド

技術スタック: typescriptnodejs
領域: documentation
Issue 種別: chore
難度: 3
推定時間: 1-2 days
活動状況: stale
明確さ: clear
前提条件: TypeScript basicsTypeDoc themingJSX/React basics
初心者向け度: 65
調査方針: Review the TypeDoc migration guide from v0.21 to v0.22, focusing on custom theming changes. Study the demo repository (Gerrit0/typedoc custom theme demo) to understand JSX theme structure. Examine the existing Handlebars based theme in the gh pages branch of Tiled (mapeditor/tiled/gh pages/docs/typedoc theme). Implement a new JSX theme and integrate it with the current documentation build process.