vue-ts 文档生成工具有没有推荐的? typedoc 不太好用

12 天前
 steins2628

如题,vite 创建的 vue3 typescript 工程,注释什么的都写好了,想要用工具直接生成对应 md 文档文件。

尝试过 typedoc ,对单一 .ts 文件支持不错,对 .vue 文件就不太行,即使加上了 typedoc-plugin-vue 插件也不太行,因为是用 <script setup> 写的,插件只支持 definecomponent 定义出来的组件。

也想过写个脚本遍历工程,提取 <script> 标签下的内容写个临时的 .ts 文件,生成完文档直接删,但是 typedoc 好像命令行没有什么设置能一次仅处理一个文件。

所以有没有什么好用的工具能直接生成对应文档的?求推荐

# typedoc.json
{
    "$schema": "https://typedoc.org/schema.json",
    "entryPoints": ["../src/App.vue"],
    "out": "./docs",
    "plugin": [
        "typedoc-plugin-vue",
        "typedoc-plugin-markdown"
    ]
}
# 项目结构示意
# {project}
- public
- typedoc
  - docs
  - package.json
  - typedoc.json
- src
  - components
    - Title
      - Title.vue
      - type.ts
  - router
    - index.ts
    - type.ts
  - store
    - index.ts
    - type.ts
  - views
    - Home
      - Home.vue
      - type.ts
    - Config
      - Config.vue
      - type.ts
  - App.vue
  - main.ts
  - types.ts
- index.html
- tsconfig.json
- vite.config.ts
- package.json
521 次点击
所在节点    Vue.js
3 条回复
hengshenyu
12 天前
vue-component-meta
rookie2luochao
11 天前
你可以试试 vite-plugin-dts 看看能不能达到你想要的效果
rookie2luochao
11 天前
@rookie2luochao 看错了,不好意思,我以为生成 dts 呢

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1050969

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX