{"id":13760661,"url":"https://github.com/ttttonyhe/odoc","last_synced_at":"2025-05-05T02:30:39.084Z","repository":{"id":42783341,"uuid":"266770647","full_name":"ttttonyhe/odoc","owner":"ttttonyhe","description":"Next.js based Static :notebook: Documentation Site Generator","archived":false,"fork":false,"pushed_at":"2023-03-05T02:12:08.000Z","size":1757,"stargazers_count":17,"open_issues_count":11,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-08T15:05:51.994Z","etag":null,"topics":["docs-generator","documentation","javascript","nextjs","npm-package","reactjs","starter-kit"],"latest_commit_sha":null,"homepage":"https://docs.ouorz.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ttttonyhe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-05-25T12:14:54.000Z","updated_at":"2023-08-19T16:49:42.000Z","dependencies_parsed_at":"2024-04-19T18:01:42.932Z","dependency_job_id":"fd8687dd-35e9-4596-b301-5a3a32ebabf7","html_url":"https://github.com/ttttonyhe/odoc","commit_stats":null,"previous_names":["helipengtony/odoc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ttttonyhe%2Fodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ttttonyhe%2Fodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ttttonyhe%2Fodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ttttonyhe%2Fodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ttttonyhe","download_url":"https://codeload.github.com/ttttonyhe/odoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252427624,"owners_count":21746247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs-generator","documentation","javascript","nextjs","npm-package","reactjs","starter-kit"],"created_at":"2024-08-03T13:01:15.776Z","updated_at":"2025-05-05T02:30:38.772Z","avatar_url":"https://github.com/ttttonyhe.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eODoc\u003c/h1\u003e\n  \u003cp\u003eOne-click-away Documentation\u003c/p\u003e\n  \u003ca href=\"https://github.com/HelipengTony/odoc\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/forks/HelipengTony/odoc.svg\" alt=\"forks\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/HelipengTony/odoc\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/HelipengTony/odoc.svg\" alt=\"stars\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/HelipengTony/odoc\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/HelipengTony/odoc.svg\" alt=\"license\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://travis-ci.com/HelipengTony/odoc\"\u003e\n    \u003cimg src=\"https://travis-ci.com/HelipengTony/odoc.svg?branch=site\" alt=\"build-status\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003e This project is not actively maintained, see documentation at [docs.ouorz.com](https://docs.ouorz.com)\n\n\u003cbr/\u003e\n\nODoc 是一个支持**热加载/预览**、一键**生产环境**部署，基于 [MDX](https://mdxjs.com) 文件生成路由的文档站点生成引擎。基于 [Next.js](https://www.nextjs.cn) 开发并支持框架提供的全部特性，插件、热预览、静态站点生成等。\n零代码需求，只需撰写 **MarkDown** 文件并通过文件夹按分类归档，即可快速生成文档站点。支持 **React 组件**的预览和内容嵌入、支持按**标题搜索**的功能(全文搜索后续更新)、通过 [Prism.js](https://prismjs.com) 支持**代码高亮**等。\n\n\u003cbr/\u003e\n\n![screenshot](https://i.loli.net/2020/06/29/Wg3LZGdAaqzew9u.png)\n\n\u003cbr/\u003e\n\n## Get Started 快速开始\n\nODoc 提供一个 Starter Kit，你可以一键安装已完善好环境配置的站点包，快速开始进行内容装载。只需在终端执行以下命令 (可通过 npm 或 yarn 安装)，当然，在此之前请确保你的本地环境支持 Node.js / TypeScript，并已经初始化好一个 NPM 项目。\n```bash\nnpm create odoc-site / yarn create odoc-site\n```\n如果出现 Connection Refused 或其他如 Promise Error 等本地网络与 Github 连接问题，请尝试直接通过以下命令获取 ODoc，克隆完成后需手动修改 odoc.config.js 以配置全局设置。\n```bash\ngit clone -b example git@github.com:HelipengTony/odoc.git\nyarn install / npm install\n```\nODoc 同时支持 i18n 国际化，你可以在 odoc.config.js 中进行语言内容配置和功能开启。需要注意的是开启 i18n 功能后必须指定语言对应的文档内容目录，详情可参照 example。\n\n\u003cbr/\u003e\n\n## Notice 必须注意\n**文件与文件夹名称必须以 X. (X 为一个数字) 开头来规定顺序**\n\n在任何一次部署之前，请执行以下命令进行引索生成：\n```bash\nyarn run generation / npm run generation\n```\n\n\u003cbr/\u003e\n\n## Slow-mo 慢速开始\n\n如果你对上面的命令行不熟悉，我们也可以从头开始讲。请先行建立一个空白文件夹，并进行 NPM 初始化：\n```bash\nnpm init / yarn init\n```\n接下来在终端执行：\n```bash\nnpm create odoc-site\n```\n如果出现 Connection Refused 或其他如 Promise Error 等本地网络与 Github 连接问题，请尝试直接通过以下命令获取 ODoc，克隆完成后需手动修改 odoc.config.js 以配置全局设置。\n```bash\ngit clone -b example git@github.com:HelipengTony/odoc.git\nyarn install / npm install\n```\n接下来进行 odoc.config.js 全局文件配置，输入关键信息：\n+ 站点名\n+ 站点在线地址\n+ 站点 Github 仓库\n+ 站点 Repo 分支\n\n![configuration_generation_1](https://i.loli.net/2020/06/29/A65Q8ioMqfYcjae.png)\n\n接下来等待自动配置步骤完成，直到出现 Done! 的提示：\n\n![configuration_generation_2](https://i.loli.net/2020/06/29/AZbDkqpRnKtiI5Y.png)\n\n接下来便可以启动你的 ODoc 项目了：\n```bash\n// Development\nyarn run dev / npm run dev\n```\n\n你现在可以修改 src/pages 目录下的内容，增加/删除或修改一个 .mdx 文件 (注意文件名开头需要的序号)。\n\n在任何一次正式部署之前，必须执行以下命令建立引索：\n```bash\nyarn run generation / npm run generation\n```\n\nODoc 同时支持 i18n 国际化，你可以在 odoc.config.js 中进行语言内容配置和功能开启。需要注意的是开启 i18n 功能后必须指定语言对应的文档内容目录，详情可参照 example。\n\n部署到开发环境：\n```bash\n// Production\nyarn run build\nyarn run start\n```\n\n\u003cbr/\u003e\n\n## Donation 赞助作者\nYour name will be on the list [Donation](https://www.ouorz.com/donation)\n\u003cbr/\u003e\n\n![Donate](https://i.loli.net/2019/02/18/5c6a80afd1e26.png)\n\n\u003cbr/\u003e\n\nFile an issue if you encountered any problem\n\u003cbr/\u003e\nI will reply you as soon as possible\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fttttonyhe%2Fodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fttttonyhe%2Fodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fttttonyhe%2Fodoc/lists"}