Skip to content

to rfvtgbzxc

一些答疑。

针对项目

生成的文档是针对脚手架的还是插件的?

同时生成。两个都可以做。

其本质是 vuepress 配置文件,扫描项目的目录结构,然后生成对应的文档。所以生成的文档可以针对脚手架,也可以针对插件

个人建议是先实现对手脚架的文档生成,再实现针对插件的文档生成。

可以自定义参考信息?

我不明白你指的参考信息是什么。

为什么文档也要放在 monorepo?

绝大多数项目都是这样做的。代码放在一侧,文档放在另一侧。

特别是自己写的文档,都是一起放在 monorepo 内的。

自动生成的 md 文件不参与 git 管理,不上传到仓库

不管我们使用的是 jsdoc 还是 typedoc,生成的文档都是 md 文件。基于代码文件生成的 md 文档,不参与管理。

生成文档的自动工作流?

这个随意。

  • github workflow
  • vercel
  • gulp

对此我暂时没有好的实践方案。我还没有涉及到自动部署+发包+部署文档的内容。但是可以肯定的是,生成文档肯定是一个命令。这个命令可以和部署命令相结合。也可以用 gulp 统一配置上述的工作任务。

大概是这样的:

  • jsdoc/typedoc 扫描文件生成 md
  • vuepress2 扫描刚刚生成的 md,和已经写好的 md,共同生成出静态网页。存放在某个 dist 内。
  • vite 手脚架扫描 rmmv/mz 模板。
  • 手脚架编译 typescript 并部署到指定路径。

这样描述确实相当抽象,不够具体。我最好是给出一个小案例为好,不过我可能没空去弄这个。😂

本文迁移

本文最好是迁移到对应的 github issue 或者是 github discussions 内,而不是在我的笔记内写明。

贡献者

The avatar of contributor named as ruan-cat ruan-cat

页面历史

布局切换

调整 VitePress 的布局样式,以适配不同的阅读习惯和屏幕环境。

全部展开
使侧边栏和内容区域占据整个屏幕的全部宽度。
全部展开,但侧边栏宽度可调
侧边栏宽度可调,但内容区域宽度不变,调整后的侧边栏将可以占据整个屏幕的最大宽度。
全部展开,且侧边栏和内容区域宽度均可调
侧边栏宽度可调,但内容区域宽度不变,调整后的侧边栏将可以占据整个屏幕的最大宽度。
原始宽度
原始的 VitePress 默认布局宽度

页面最大宽度

调整 VitePress 布局中页面的宽度,以适配不同的阅读习惯和屏幕环境。

调整页面最大宽度
一个可调整的滑块,用于选择和自定义页面最大宽度。

内容最大宽度

调整 VitePress 布局中内容区域的宽度,以适配不同的阅读习惯和屏幕环境。

调整内容最大宽度
一个可调整的滑块,用于选择和自定义内容最大宽度。

聚光灯

支持在正文中高亮当前鼠标悬停的行和元素,以优化阅读和专注困难的用户的阅读体验。

ON开启
开启聚光灯。
OFF关闭
关闭聚光灯。