Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.61 KB

README.md

File metadata and controls

44 lines (28 loc) · 2.61 KB

ClassIsland 文档

这是 ClassIsland 文档仓库。本文档基于 VuePress 搭建

在线查看文档

开始编写文档

  1. 安装 Node 20 环境(推荐使用NVM)

  2. 克隆并进入文档仓库

  3. 安装依赖(需要使用pnpm,可使用corepack安装)

    pnpm install
  4. 启动 VuePress 服务器

    pnpm run docs:dev

启动 VuePress 服务器后,在浏览器中打开终端输出的链接(默认是http://localhost:8080/classisland-docs-next/)即可浏览文档。当本地文档做出更改时,浏览器中的文档将自动刷新。

本文档使用了 vuepress-plugin-md-enhance 的一些扩展语法,请尽量直接编辑 Markdown 文件,而不是使用可视化 Markdown 编辑器。建议使用 Visual Studio Code 编辑文档。

关于 VuePress 和 vuepress-plugin-md-enhance 的用法,请参见 VuePress 文档vuepress-plugin-md-enhance 文档

做出贡献

如果您有意愿为本文档做出贡献,请先阅读贡献指南。我们欢迎向本仓库提交 Pull Request

致谢

感谢以下为本文档做出贡献的同学:

贡献者名单

许可证

本文档以 CC BY-NC-SA 4.0 许可协议授权。