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 留言) (0 反應) (0 負責人)C++ (10,413 star) (1,708 fork)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
議題類型: 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.