欢迎使用 ODoc
ODoc 是一个支持热加载/预览、一键生产环境部署，基于 MDX 文件生成路由的文档站点生成引擎。基于 Next.js 开发并支持框架提供的全部特性，插件、热预览、静态站点生成等。 零代码需求，只需撰写 MarkDown 文件并通过文件夹按分类归档，即可快速生成文档站点。支持 React 组件的预览和内容嵌入、支持按标题搜索的功能(全文搜索后续更新)、通过 Prism.js 支持代码高亮等。
MarkDown 支持
功能 .MDX / .MD 页面基于 Next.js
功能 支持 .tsx / .jsx 页面内置搜索支持
更新中 支持标题搜索文件自动路由
功能 按照文件目录生成路由快速开始
ODoc 提供一个 Starter Kit，你可以一键安装已完善好环境配置的站点包，快速开始进行内容装载。只需在终端执行以下命令 (可通过 npm 或 yarn 安装)，当然，在此之前请确保你的本地环境支持 Node.js / TypeScript，并已经初始化好一个 NPM 项目。
npm create odoc-site / yarn create odoc-site
慢速开始
如果你对上面的命令行不熟悉，我们也可以从头开始讲。请先行建立一个空白文件夹，并进行 NPM 初始化：
npm init / yarn init
接下来在终端执行：
npm create odoc-site
关键目录指南
Introduction to ODoc
ODoc enables you to quickly create live-reloading, production-ready documentation sites with MDX. It is based on Next.js so you get all its awesome features with it. 0 line of code is needed, just write Markdown. It supports MDX, title searching, file-system based routing and built-in syntax highlighting. If you want to see how it looks just look read the documentation, this entire site is built with ODoc starting from some markdown files.