{"id":26131261,"url":"https://github.com/chenbimo/yidocs","last_synced_at":"2026-06-05T05:31:28.016Z","repository":{"id":276689298,"uuid":"929967250","full_name":"chenbimo/yidocs","owner":"chenbimo","description":"易文档","archived":false,"fork":false,"pushed_at":"2025-05-31T16:25:42.000Z","size":441,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-01T04:52:34.371Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chenbimo.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-09T20:02:50.000Z","updated_at":"2025-05-31T16:25:46.000Z","dependencies_parsed_at":"2025-05-31T17:40:57.026Z","dependency_job_id":"7904ff52-0979-4e06-a519-6a708a465e89","html_url":"https://github.com/chenbimo/yidocs","commit_stats":null,"previous_names":["chenbimo/yidocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chenbimo/yidocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenbimo%2Fyidocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenbimo%2Fyidocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenbimo%2Fyidocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenbimo%2Fyidocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chenbimo","download_url":"https://codeload.github.com/chenbimo/yidocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenbimo%2Fyidocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27759599,"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","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-10T21:55:20.545Z","updated_at":"2025-12-16T04:56:24.088Z","avatar_url":"https://github.com/chenbimo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yidocs 是什么？\n\n中文名称 `易文档`，基于`vitepress`进一步封装而来。\n\n旨在提供更加简单，易用，好用的文档体验。\n\n### 仓库地址\n\n[github - https://github.com/chenbimo/yidocs](https://github.com/chenbimo/yidocs)\n\n### 效果演示\n\n笔者的个人文章就是基于`yidocs`搭建的，点击查看即可。\n\n[前端之虎陈随易 https://chensuiyi.me](https://chensuiyi.me)\n\n### 功能特点\n\n- ✅ 无需手动配置，自动生成导航栏。\n- ✅ 无需手动配置，自动生成侧边栏。\n- ✅ 良好的文档组织，顺序确定，无错乱。\n\n### 为什么使用 yidocs\n\n`yidocs` 开箱即用，并且无需手动配置 `侧边栏` 和 `导航栏`。\n\n如果我们使用 `vitepress`，需要的配置如下：\n\n```javascript\nexport default {\n    themeConfig: {\n        sidebar: {\n            '/guide/': [\n                {\n                    text: 'Guide',\n                    items: [\n                        { text: 'Index', link: '/guide/' },\n                        { text: 'One', link: '/guide/one' },\n                        { text: 'Two', link: '/guide/two' }\n                    ]\n                }\n            ],\n\n            '/config/': [\n                {\n                    text: 'Config',\n                    items: [\n                        { text: 'Index', link: '/config/' },\n                        { text: 'Three', link: '/config/three' },\n                        { text: 'Four', link: '/config/four' }\n                    ]\n                }\n            ]\n        }\n    }\n};\n```\n\n使用 `yidocs`，配置如下即可：\n\n```javascript\nimport { docsAuto } from '@yidocs/auto';\nlet { sideBar, navBar } = docsAuto();\nexport default {\n    themeConfig: {\n        sidebar: sideBar,\n        nav: navBar\n    }\n};\n```\n\n最苦、最累、最麻烦的问题，交给笔者。\n\n最好、最强、最方便的功能，留给你们。\n\n### 下载使用\n\n**下载 yidocs 接口开发模板**\n\n如果你使用的是 `npm`：\n\n```bash\nnpx dloo -n yidocs\n```\n\n如果你使用的是 `pnpm`：\n\n```bash\npnpm dlx dloo -n yidocs\n```\n\n下载流程如下图。\n\n```bash\nD:\\codes\\chensuiyi\\dloo\u003epnpm dlx dloo.js -n yidocs\nℹ 开发者：陈随易（https://chensuiyi.me）\n-----------------------------------------\nℹ yidocs 接口项目开发模板下载中...\n✔ 资源已下载到默认的 .dloo 目录，请移动到正确的目录!\n```\n\n将`.dloo` 目录中的`yidocs`模板全部复制到当前目录下，执行`pnpm install`安装命令，然后执行`pnpm run dev`命令查看效果。\n\n## 设计理念\n\n当然，要想如此方便地使用 `yidocs`，一些必要的约定还是要遵守的。\n\n```bash\n├───📁 markdown/\n│   ├───📁 1-开源/\n│   │   ├───📁 1-yite-cli/\n│   │   │   ├───📁 1-基本简介/\n│   │   │   │   ├───📄 1-基本介绍.md\n│   │   │   │   ├───📄 2-快速体验.md\n│   │   │   │   ├───📄 3-项目结构.md\n│   │   │   │   └───📄 4-视频入门.md\n```\n\n**命名约定**\n\n所有文件和目录，都要以 `数字-` 开头\n\n如上所示，任何目录和文章，均以 `数字` + `短横线` 开头，作用就是用于 `文章` 和 `目录` 的排序。\n\n如果没有人为的 `数字标识`，文档的目录和排序有可能是乱套的，所以此为 `yidocs` 的必要要求之一。\n\n**层级约定**\n\n一共有`2-3-4`三种结构层级。\n\n```bash\n├───📁 markdown\n│   ├───📁 1-一级结构\n│   │   └───📄 1-文章.md\n│   ├───📁 2-二级结构\n│   │   ├───📁 1-目录\n│   │   │   └───📄 1-文章.md\n│   ├───📁 2-三级结构\n│   │   ├───📁 1-目录\n│   │   │   ├───📁 1-目录\n│   │   │   │   └───📄 1-文章.md\n\n```\n\n![一级结构](https://static.yicode.tech/images/202502/20250210102953.png)\n\n一级结构在顶部导航没有`箭头`，点击即会展示该文章内容，适合`目录-文章`的模式，比如`关于我`。\n\n![二级结构](https://static.yicode.tech/images/202502/20250210103037.png)\n\n二级结构类似`下拉列表`，需要选择其`二级菜单`才会显示对应的文章内容，适合`分类-目录-文章`的模式，比如说明书。\n\n![三级结构](https://static.yicode.tech/images/202502/20250210103138.png)\n\n三级结构会把目录下的所有目录展示在侧边栏，适合`分类-项目-目录-文章`的模式，比如复杂的开源手册。\n\n这就是 `yidocs` 的文件组织结构。\n\n不满足此规则的文件，在编译的控制台将会进行提示，且对应文件将不会在文档中显示。\n\n建议不想显示的目录或文章，使用`下划线+名称`的模式命名，这样所有的隐藏目录或文件都会在目录的顶部展示，比如`_这是隐藏文件.md`。\n\n### 插件扩展\n\n`yidocs` 提供了实用的插件，可以一键安装使用。\n\n#### 会员内容隐藏插件 - @yicocs/vip\n\n![插件效果](https://static.yicode.tech/images/202502/20250210104134.png)\n\n**安装：**\n\n```bash\npnpm add @yidocs/vip\n```\n\n**配置：**\n\n```js\nimport markdownItVip from '@yidocs/vip';\nexport default {\n    markdown: {\n        theme: 'one-dark-pro',\n        lineNumbers: true,\n        config: (md) =\u003e {\n            md.use(markdownItVip);\n        }\n    }\n};\n```\n\n**使用：**\n\n格式如下：\n\n开头：`\u003c!--vipStart--标题--\u003e`。\n\n结尾：`\u003c!--vipEnd--\u003e`。\n\n```markdown\n\u003c!--vipStart--全文阅读地址👉https://sourl.cn/r6DNRy--\u003e\n\n这是会员隐藏内容\n\n\u003c!--vipEnd--\u003e\n```\n\n### 版权说明\n\n`yidocs(易文档)` 使用 `Apache 2.0` 协议开源\n\n\u003e 一句话总结：开源不等于放弃版权，不可侵犯原作者版权，改动处要做说明，可以闭源使用。\n\n拥有版权（Copyright）意味着你对你开发的软件及其源代码拥有著作权，所有权和其他法定权利，使用一个开源协议并不意味着放弃版权。\n\n在 `Apache 2.0` 协议许可下，您可以：\n\n- **商业化使用**（这意味着，您可以出于商业目的使用这些源代码）\n- **再分发**（这意味着，您可以将源代码副本传输给其他任何人）\n- **修改**（这意味着，您可以修改源代码）\n- **专利使用**（这意味着，版权人明确声明授予您专利使用权）\n- **私人使用**（这意味着，您可以出于一切目的私下使用和修改源代码）\n\n唯须遵守以下条款：\n\n- **协议和版权通知**（这意味着，软件中必须包含许可证和版权声明的副本）\n- **状态更改说明**（如果您更改软件，您应当提供适当的说明）\n\n除此之外，该软件：\n\n- **提供责任限制**（版权人声明不对使用者造成的任何损失负责）\n- **限制商标使用** (不能使用版权人的商标)\n- **不提供任何担保**（版权人声明不为该软件的品质提供任何担保）\n\n进一步说明：\n\n1. 本软件又叫本 **作品**，可以是源码，也可以是编译或转换后的其他形式。**衍生作品** 是在本作品的基础上修改后的有原创性的工作成果。本作品的 **贡献者** 包括许可人和其他提交了贡献的人，以下统称 **我**。\n2. 我授予你权利：你可以免费复制、使用、修改、再许可、分发本作品及衍生作品（可以不用公开源码）。\n3. 如果本软件涉及我的专利（或潜在专利），我在此授予你专利许可，你可以永久性地免费使用此专利，用于制作、使用、出售、转让本作品。如果你哪天居然告本作品侵权，你的专利许可在你告我那天被收回。\n4. 你在复制和分发本作品或衍生作品时，要满足以下条件。\n\n    - 带一份本许可证。\n    - 如果你修改了什么，要在改动的文件中有明显的修改声明。\n    - 如果你以源码形式分发，你必须保留本作品的版权、专利、商标和归属声明。\n    - 如果本作品带了 **NOTICE** 文件，你就得带上 **NOTICE** 文件中包含的归属声明。即便你的发布是不带源码的，你也得带上此文件，并在作品某处予以展示。\n    - 你可以对自己的修改添加版权说明。对于你的修改或者整个衍生作品，你可以使用不同的许可，但你对本作品的使用、复制和分发等，必须符合本许可证规定。\n\n5. 你提交贡献就表明你默认遵守本许可的条款和条件。当然，你可以和我签订另外的专门的条款。\n6. 你不许使用我的商品名、商标、服务标志或产品名。\n7. 本作品是 **按原样**（AS IS）提供的，没有任何保证啊，你懂的。\n8. 我可不负任何责任。除非我书面同意，或者法律有这样的要求（例如对故意和重大过失行为负责）。\n9. 你可以向别人提供保证，你可以向别人收费，但那都是你的事，别给我惹麻烦。\n\n注意以上的 **我**，既包含了许可人，也包含了每位 **贡献者**。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchenbimo%2Fyidocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchenbimo%2Fyidocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchenbimo%2Fyidocs/lists"}