TypeDoc

 TypeDocから、mdとmermaidを出力する。

• TypeDoc

yarn

yarn add -D typedoc

yarn

yarn add -D typedoc-plugin-markdown

 entryPointsを指定し、mdにするファイルを指定。

typedoc.json

{
  "entryPoints": ["./**/*.ts"]
}

 --outで、出力先ディレクトリを指定。

yarn

yarn typedoc --plugin typedoc-plugin-markdown --out ./docs/typedoc/

Mermaid

yarn

yarn add -D typedoc-plugin-mermaid

typedoc.json

{
  "entryPoints": ["./**/*.ts"],
  "plugin": ["typedoc-plugin-mermaid"]
}

Example

honox.ts

import { OpenAPIHono } from '@hono/zod-openapi'
import { routes } from '../openapi'

export class HonoXHandler {
  /**
   * HonoX Handler apply
   * apply(app: OpenAPIHono)
   * @param app
   * routes['HonoX']
   * ```mermaid
   * sequenceDiagram
   *   Client ->> Handler: /api/honox
   *   Handler -->> Client: { message: 'HonoX🔥' }
   * ```
   */
  static apply(app: OpenAPIHono) {
    return app.openapi(routes['HonoX'], async (c) => {
      return c.json({ message: 'HonoX🔥' })
    })
  }
}

 以下のように、生成できます。

Methods

apply()

static apply(app): OpenAPIHono<Env, object, "/">

HonoX Handler apply apply(app: OpenAPIHono)

Parameters

• app: OpenAPIHono<Env, object, "/">

routes['HonoX']

Returns

OpenAPIHono<Env, object, "/">

No Markdown

 outで指定した、ディレクトリにhtmlファイルが作成される。

yarn

yarn typedoc

typedoc.json

{
  "name": "Title",
  "entryPoints": ["./**/*.ts"],
  "out": "./docs/typedoc/"
}