跳转到内容
彼岸论坛
欢迎抵达彼岸 彼岸花开 此处谁在 -彼岸论坛

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


小天管理

已推荐帖子

如题,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
意见的链接
分享到其他网站

加入讨论

您现在可以发表并稍后注册. 如果您是会员,请现在登录来参与讨论.

游客
回复主题...

×   粘贴为富文本.   粘贴为纯文本来代替

  只允许使用75个表情符号.

×   您的链接已自动嵌入.   显示为链接来代替

×   您之前的内容已恢复.   清除编辑器

×   您无法直接粘贴图片.要从网址上传或插入图片.

  • 游客注册

    游客注册

  • 会员

    没有会员可显示

  • 最新的状态更新

    没有最新的状态更新
  • 最近查看

    • 没有会员查看此页面.
×
×
  • 创建新的...