{"id":20325533,"url":"https://github.com/opencurve/curve-book","last_synced_at":"2025-04-11T19:52:49.926Z","repository":{"id":184140563,"uuid":"671346769","full_name":"opencurve/curve-book","owner":"opencurve","description":"curve book, knowledge base","archived":false,"fork":false,"pushed_at":"2023-12-28T09:33:21.000Z","size":40850,"stargazers_count":1,"open_issues_count":4,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T15:49:35.438Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opencurve.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":"2023-07-27T05:46:03.000Z","updated_at":"2024-07-01T12:36:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"64454cd3-23c4-4c90-b59e-8e5b29bed004","html_url":"https://github.com/opencurve/curve-book","commit_stats":null,"previous_names":["opencurve/curve-book"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencurve%2Fcurve-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencurve%2Fcurve-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencurve%2Fcurve-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencurve%2Fcurve-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencurve","download_url":"https://codeload.github.com/opencurve/curve-book/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248472201,"owners_count":21109619,"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-14T19:40:25.840Z","updated_at":"2025-04-11T19:52:49.898Z","avatar_url":"https://github.com/opencurve.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 如何提交文档\n\n文档界面一般分为3大部分，左侧导航栏，中间内容，右侧文档TOC。\n\n左侧导航栏由目录结构直接生成，右侧文档TOC由markdown header解析生成。\n\n## 目录结构介绍\n\n所有的文档在docs目录下。结构预期如下\n\n```\nintro.md (网站介绍页面，打开网站的默认页面)\ncurvebs\n    - _category_.json\n    - deploy\n        - _category_.json\n        - offline-deploy.md\n    ...\ncurvefs\n    ...\n```\n\n这里主要分为两块\n\n1. markdown文档，一般无需更多设置\n2. 目录层级，在每个目录下，需要一个_category_.json，来描述这个目录的名称，排序，目录index生成，能否折叠，默认是否折叠等\n\n一个完整的_category_.json的example\n\n```json\n{\n  \"position\": 2,\n  \"label\": \"Tutorial\",\n  \"collapsible\": true,\n  \"collapsed\": false,\n  \"className\": \"red\",\n  \"link\": {\n    \"type\": \"generated-index\",\n    \"title\": \"Tutorial overview\"\n  },\n  \"customProps\": {\n    \"description\": \"This description can be used in the swizzled DocCard\"\n  }\n}\n```\n\n一般只需要如下的example, 顺序我们将约定使用数字前缀进行标识。\n\n```json\n{\n  \"label\": \"Tutorial\",\n  \"link\": {\n    \"type\": \"generated-index\",\n  }\n}\n```\n\n## how to\n\n### 已有目录添加文档\n\n直接添加文档即可\n\n### 需要修改目录结构\n\n1. 添加对应的目录和_category_.json\n2. 然后添加文档即可\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencurve%2Fcurve-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencurve%2Fcurve-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencurve%2Fcurve-book/lists"}