{"id":19736412,"url":"https://github.com/erda-project/docs","last_synced_at":"2025-09-10T04:42:38.085Z","repository":{"id":36950206,"uuid":"344670981","full_name":"erda-project/docs","owner":"erda-project","description":"Erda's user documentation","archived":false,"fork":false,"pushed_at":"2024-10-25T02:25:12.000Z","size":3457,"stargazers_count":33,"open_issues_count":4,"forks_count":58,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-02T04:07:42.333Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/erda-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2021-03-05T02:28:57.000Z","updated_at":"2024-10-25T02:25:19.000Z","dependencies_parsed_at":"2023-01-17T07:31:11.391Z","dependency_job_id":"e938b058-5eea-4794-8bdf-b2d8fa04eefb","html_url":"https://github.com/erda-project/docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erda-project%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erda-project%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erda-project%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erda-project%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erda-project","download_url":"https://codeload.github.com/erda-project/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987285,"owners_count":21028895,"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":[],"created_at":"2024-11-12T01:07:04.520Z","updated_at":"2025-04-09T06:12:38.598Z","avatar_url":"https://github.com/erda-project.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Erda 用户文档\n\n## 文档开发\n*提前安装好 node \u003e= 12*\n\n```bash\nnpm i # 如果已安装过依赖，可跳过\nnpm run dev\n```\n本地服务启动后，按提示访问（默认是`http://localhost:8080/`）即可看到预览效果，改动后自动刷新。\n如果某个改动导致页面白屏，可能是js报错了，需要重启一下服务再尝试。\n\n### 文档结构\n```\ndocs\n  - .vuepress 项目配置\n    - nav     导航菜单配置\n    - sidebar 侧边栏菜单配置\n    - ...     其他前端文件，基本不用修改\n  - 2.0       2.0版本文档\n  - next      下个版本文档\n  - en\n    - 2.0 英文版2.0文档\n```\n\nvuepress会把除`.vuepress`目录以外的目录下，所有的markdown、vue文件，按照同样的目录结构转为html文件。\n每个目录下的 README.md 会作为 index.html。\n推荐每个目录都有一个 README.md 文件，避免用户访问某一个路径时出现404的问题。\n\n### 导航菜单配置\n在`.vuepress/nav/zh.js`中修改\n```js\nmodule.exports = [\n  {\n    text: '使用手册',\n    link: '/manual/' // 有最后的/时，表示是个目录，需要有/manual/README.md\n  },\n  {\n    text: 'CHANGELOG',\n    link: '/changeLog' // 没有最后的/时，表示是个文件，需要有/changeLog.md文件\n  },\n  {\n    text: 'FAQ',\n    link: '/faq'\n  },\n  {\n    text: '了解更多',\n    ariaLabel: '了解更多',\n    items: [ // 有多级菜单时\n      {\n        text: '产品架构',\n        link: '/architecture'\n      },\n      {\n        text: '其他',\n        items: [\n          {\n            text: 'Changelog',\n            link: 'https://github.com/vuejs/vuepress/blob/master/CHANGELOG.md'\n          }\n        ]\n      }\n    ]\n  },\n]\n```\n\n### 侧边栏菜单配置\n在`.vuepress/sidebar/zh.js`中修改\n```js\n  '/doc/guide/': [] // 按最先匹配到的，所以精确匹配的要放在前面\n  '/doc/': [ // 匹配路径，前后都有/，当在这个路径下时，使用下面的配置作为菜单\n    {\n      title: '快速上手',\n      collapsable: true, // 是否可折叠\n      children: [ // 二级菜单\n        'guide/', // 添加key作为路径前缀，这个指向/doc/guide/README.md\n        'guide/getting-started', // 指向/doc/guide/getting-started.md\n        '../api/cli', // 其他目录下的使用相对路径，这个指向/api/cli.md\n      ]\n    },\n    {\n      title: 'groupB',\n      collapsable: true,\n      children: [\n      ]\n    }\n  ],\n```\n\n默认情况下，侧边栏会自动地显示由当前页面的标题（headers）组成的链接，并按照页面本身的结构进行嵌套，你可以通过以下代码来修改它的行为。\n默认的深度是 1，它将提取到 h2 的标题，设置成 0 将会禁用标题（headers）链接，同时，最大的深度为 2，它将同时提取 h2 和 h3 标题。\n```js\n---\nsidebarDepth: 0\n---\n```\n\n如果所有内容都在一个文件内，且侧边栏没有分组，或分组不需要展开收起，可以直接在该文件头部添加如下内容，\n可以自动根据h1\\h2\\h3层级生成侧边栏菜单\n```js\n---\nsidebar: auto\n---\n```\n\n### 设置主页模板\n在任意文件顶部加入如下代码，会在该页加入首页的模板，就是一个logo+描述+按钮+footer\n```js\n---\nhome: true\nheroImage: //terminus-paas.oss-cn-hangzhou.aliyuncs.com/paas-doc/2020/06/09/0b9da3f2-8aa6-4a5f-b649-96f09d874c25.png\nactionText: 快速上手\nactionLink: /manual/guide/getting-started\nfooter: Copyright © 2012-present terminus\n---\n```\n\n### 注意事项\n不要在文档中直接写 {{ }}, 除非用 ``` 代码块包裹，否则应使用以下任意一种方式：\n```\n\u003ccode v-text=\"'{{ ... }}'\"/\u003e\n\u003ccode v-pre\u003e{{ ... }}\u003c/code\u003e\n{{'{\\{ ... }\\}'}}\n```\n\n### 其他\n支持类型：\n* table\n* 标签，有tip|warning|error三种类型，对应绿、黄、红三种颜色\n```\n\u003cBadge type=\"warning\" text=\"beta\" /\u003e\n```\n* [Emoji](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.json)\n* 提示区块，有tip|warning|danger|details四种类型\n```\n::: tip 这是提示标题\n这是一个提示\n:::\n```\n\n* 视频，注意必须用 ClientOnly 包一下\n```\n\u003cClientOnly\u003e\n  \u003cvideo-player title=\"测试视频\" src=\"https://static.erda.cloud/site/video/erda.mp4\"\u003e\u003c/video-player\u003e\n\u003c/ClientOnly\u003e\n```\n* 代码块的行高亮和显示行号\n* 自定义组件\n\n\n更多配置参考[vuepress官方文档](https://vuepress.vuejs.org/)\n\n\n### 编辑流程\n1. 新建 feature 分支，完成初稿，提交前执行`npm run lint-md`检查文档格式，没问题后执行提交\n2. 比较 feature 分支和 develop 分支发 Merge Request, 完成 Review 后合并分支\n3. 定期把 develop 分支 merge 到 master 分支, 进行升级\n\n### 编写规范\n1. 截图使用 Mac 14 寸小屏非全屏(Shift + Command + 4 + 空格 + 单击) ，注意隐藏书签(Shift + Command + B)、关闭无关 Tab 页、项目图片请选择比较正式的terminus图片，项目或应用描述请填写比较正式的描述信息。\n2. 截图使用内部 Uploader 服务上传至 OSS。\n3. 中英文混排，英文前后必须有空格。\n4. **不要使用类似`\u003cproject\u003e`这样用尖括号包裹的占位符，如果需要使用请用代码块包裹起来**\n\n## 发布版本\n注意，目前只会保留最近三个版本的文档，next 目录为当前迭代中的文档，每个迭代完成后，从 next 目录 release 出新版本文档\n1. 复制一份 next 目录并改名为新版本\n2. `.vuepress/sidebar/vers` 目录下增加新版的左侧菜单配置\n3. 移动旧版本目录到 `archive` 目录下，避免影响打包速度，因为 vuepress 会扫描 `docs` 目录下所有文件\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferda-project%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferda-project%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferda-project%2Fdocs/lists"}