{"id":19327552,"url":"https://github.com/deepflowio/docs","last_synced_at":"2025-02-24T06:26:15.091Z","repository":{"id":40268049,"uuid":"491745313","full_name":"deepflowio/docs","owner":"deepflowio","description":"DeepFlow Docs","archived":false,"fork":false,"pushed_at":"2024-08-13T08:45:46.000Z","size":22932,"stargazers_count":4,"open_issues_count":3,"forks_count":19,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-08-13T10:14:37.926Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://deepflow.io/docs/","language":"Vue","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/deepflowio.png","metadata":{"files":{"readme":"README-CN.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":"2022-05-13T03:34:11.000Z","updated_at":"2024-08-15T04:27:11.168Z","dependencies_parsed_at":"2024-08-15T13:26:45.655Z","dependency_job_id":null,"html_url":"https://github.com/deepflowio/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/deepflowio%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepflowio%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepflowio%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepflowio%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepflowio","download_url":"https://codeload.github.com/deepflowio/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240428797,"owners_count":19799721,"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-10T02:17:34.069Z","updated_at":"2025-02-24T06:26:15.063Z","avatar_url":"https://github.com/deepflowio.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [DeepFlow-docs](https://deepflow.yunshan.net/deepflow-docs/zh/)\n\n# markdown 编写注意事项\n\n1. HOME 文件不可删除，属于各语言下的首页内容，其 markdown 里面的内容可以调整。\n2. 多语言版本文件目录需要一一对应，比如说存在`/test.md`，那么`/zh/test.md`也一定要存在，否则会 404。\n3. 文件命名需要增加序列号，比如说`/01-about/01-test.md`，框架会自动把`01`拿去排序，`/about/test/`作为访问地址。\n4. markdown 文件一定要写 title 属性，因为文件名是一样的，但是在中英文下左侧目录是不同的，中文下需要显示中文目录，故需要在 md 顶部提前写好 title 属性。格式：（**三**个中划线）\n\n```md\n---\ntitle: xxx\n---\n\n内容\n```\n\n5. 左侧目录翻译写在`/LOCALES`路径对应的语言文件内，支持书写路径，但是需要从头（非语言）开始写。\n\n```md\neg: {\n\"about\": \"关于\",\n\"agent\": \"采集器\",\n\"agent/about\": \"关于采集器\"\n}\n\n翻译：\n\nI. /zh/about: 关于\nII. /zh/agent: 采集器\nIII. /zh/agent/about: 采集器/关于采集器\n\nTip: `zh/agent/about`翻译成`采集器/关于采集器`，是因为需要保留目录结构。\n```\n\n6. markdown 内的图片大小控制方案。\n\n```md\n![DeepFlow软件架构](./imgs/deepflow-architecture.png) // 无规则，宽高皆自适应\n![DeepFlow软件架构](./imgs/deepflow-architecture.png?w=120) // 宽度为 120 的图片，高度随比例变化\n![DeepFlow软件架构](./imgs/deepflow-architecture.png?h=120) // 高度为 120 的图片，宽度随比例变化\n![DeepFlow软件架构](./imgs/deepflow-architecture.png?w=120\u0026h=120) // 宽高都为 120 的图片，比例写死（不建议使用）\n![DeepFlow软件架构](./imgs/deepflow-architecture.png?align=center) // 图片对齐方式，align 取值分别是 center(居中)，left(靠左)，right(靠右)。默认 left\n以上属性可结合使用，多属性用`\u0026`拼接\n```\n\n7. 文字块\n\n```md\n::: tip\n这是一个提示\n:::\n\n::: warning\n这是一个警告\n:::\n\n::: danger\n这是一个危险警告\n:::\n\n::: details\n这是一个详情块，在 IE / Edge 中不生效\n:::\n\n::: tip 名字\n这是一个带有名字的提示\n:::\n```\n\n输出\n\n![文字块](./images/text-block-zh.jpg)\n\n8. 关于 markdown 内图片 url 资源引用问题，目前新模式下，图片 url 资源不参与编译，故直接使用编译后的地址即可。（编译会去掉序号）\n\n```md\n旧版: ![DeepFlow软件架构](./../01-about/imgs/deepflow-architecture.png)\n新版: ![DeepFlow软件架构](./../about/imgs/deepflow-architecture.png)\n```\n\n9. 文档脚注\n\na. 2 种写法，内联+非内联\n\nb. 脚注会统一在文档底部排版\n\nc. 引用源的分号是英文分号\n\nd. 找不到引用源的脚注会原样显示，不做任何修改\n\n```md\n脚注 1 链接[^first].\n\n脚注 2 链接[^second].\n\n行内的脚注^[Text of inline footnote] 定义.\n\n重复的页脚定义[^second].\n\n找不到引用源的脚注，会原样显示[^third]\n\n[^first]: 脚注\n[^second]: 脚注文字。\n```\n\n![脚注](./images/foot-note-zh.jpg)\n\n10. 代码块分组\n\n````\n::: code-tabs#shell\n\n@tab pnpm\n\n```bash\npnpm install\n```\n\n@tab npm\n\n```bash\nnpm install\n```\n\n@tab yarn\n\n```bash\nyarn install\n```\n\n:::\n\n````\n\n11. 从 csv 文件地址中生成数据显示\n\na. 如果地址错误，则不会生成csv数据\n\nb. 如果数据返回不是以`#`开头，也不会生成csv数据\n\nc. 最后csv内容需要以`,`分隔数据，否则无法解析显示\n\nd. 第一行`#`开头的是csv头部, 其余以`#`的行是注释，最后非空行的是csv内容\n\n```\n[csv-$csvTitle]($csvURL)\n\neg:\n[csv-L7 Protocol List](https://raw.githubusercontent.com/deepflowio/deepflow/main/server/querier/db_descriptions/clickhouse/tag/enum/l7_protocol)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepflowio%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepflowio%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepflowio%2Fdocs/lists"}