Nólëbase

切换主题

apidoc 安装 ​

字数
125 字
阅读时间
1 分钟

此教程默认已安装 Node.js 环境

安装 ​

shell
pnpm install -g apidoc@0.19.0

使用 ​

命令说明：

  1. 参数 i 表示扫描的目录
  2. 参数 p 表示输出 apidoc 文件的目录
shell
apidoc -i ./ -o ../apidoc/<项目名称>/

暴露为外部可访问服务器 ​

使用 serve 命令打开一个网页服务器 命令说明：

  1. 参数 l，表示监听的端口
shell
serve -l <端口> ../apidoc/<项目名称>/

贡献者

The avatar of contributor named as 絢香猫 絢香猫The avatar of contributor named as Nisekoi Nisekoi

页面历史

用 ♥ 撰写

CC BY-SA 4.0 © 2022-PRESENT Nólëbase 的创作者们

布局切换

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

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

页面最大宽度

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

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

内容最大宽度

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

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

聚光灯

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

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

聚光灯样式

调整聚光灯的样式。

置于底部
在当前鼠标悬停的元素下方添加一个纯色背景以突出显示当前鼠标悬停的位置。
置于侧边
在当前鼠标悬停的元素旁边添加一条固定的纯色线以突出显示当前鼠标悬停的位置。