typedoc

June 14, 2024

Table of Contents

typedoc

似たものでtypedocというものを見つけたので、これを使ってみた

npm i -D typedoc

typedoc.jsonを作成

npx typedoc

で生成される。こっちのほうはhtmlで生成される

使えるタグも多いのでドキュメント生成前提ならこちらのほうがよさげ

デフォルトだとプロパティがabcで並び替えられたので、変更しないように設定

{
    "$schema": "https://typedoc.org/schema.json",
    "entryPoints": [
        "./src"
    ],
    "entryPointStrategy": "expand",
    "out": "docs/typedoc",
    "sort": [
        "source-order"
    ]
}