ODoc

One-click-away Documentation

This project is not actively maintained, see documentation at docs.ouorz.com

ODoc 是一个支持热加载/预览、一键生产环境部署，基于 MDX 文件生成路由的文档站点生成引擎。基于 Next.js 开发并支持框架提供的全部特性，插件、热预览、静态站点生成等。 零代码需求，只需撰写 MarkDown 文件并通过文件夹按分类归档，即可快速生成文档站点。支持 React 组件的预览和内容嵌入、支持按标题搜索的功能(全文搜索后续更新)、通过 Prism.js 支持代码高亮等。

Get Started 快速开始

ODoc 提供一个 Starter Kit，你可以一键安装已完善好环境配置的站点包，快速开始进行内容装载。只需在终端执行以下命令 (可通过 npm 或 yarn 安装)，当然，在此之前请确保你的本地环境支持 Node.js / TypeScript，并已经初始化好一个 NPM 项目。

npm create odoc-site / yarn create odoc-site

如果出现 Connection Refused 或其他如 Promise Error 等本地网络与 Github 连接问题，请尝试直接通过以下命令获取 ODoc，克隆完成后需手动修改 odoc.config.js 以配置全局设置。

git clone -b example git@github.com:HelipengTony/odoc.git
yarn install / npm install

ODoc 同时支持 i18n 国际化，你可以在 odoc.config.js 中进行语言内容配置和功能开启。需要注意的是开启 i18n 功能后必须指定语言对应的文档内容目录，详情可参照 example。

Notice 必须注意

文件与文件夹名称必须以 X. (X 为一个数字) 开头来规定顺序

在任何一次部署之前，请执行以下命令进行引索生成：

yarn run generation / npm run generation

Slow-mo 慢速开始

如果你对上面的命令行不熟悉，我们也可以从头开始讲。请先行建立一个空白文件夹，并进行 NPM 初始化：

npm init / yarn init

接下来在终端执行：

npm create odoc-site

如果出现 Connection Refused 或其他如 Promise Error 等本地网络与 Github 连接问题，请尝试直接通过以下命令获取 ODoc，克隆完成后需手动修改 odoc.config.js 以配置全局设置。

git clone -b example git@github.com:HelipengTony/odoc.git
yarn install / npm install

接下来进行 odoc.config.js 全局文件配置，输入关键信息：

• 站点名
• 站点在线地址
• 站点 Github 仓库
• 站点 Repo 分支

接下来等待自动配置步骤完成，直到出现 Done! 的提示：

接下来便可以启动你的 ODoc 项目了：

// Development
yarn run dev / npm run dev

你现在可以修改 src/pages 目录下的内容，增加/删除或修改一个 .mdx 文件 (注意文件名开头需要的序号)。

在任何一次正式部署之前，必须执行以下命令建立引索：

yarn run generation / npm run generation

ODoc 同时支持 i18n 国际化，你可以在 odoc.config.js 中进行语言内容配置和功能开启。需要注意的是开启 i18n 功能后必须指定语言对应的文档内容目录，详情可参照 example。

部署到开发环境：

// Production
yarn run build
yarn run start

Donation 赞助作者

Your name will be on the list Donation

File an issue if you encountered any problem
I will reply you as soon as possible