{"id":37144003,"url":"https://github.com/jarvanstack/gitbook-summary","last_synced_at":"2026-01-14T16:54:36.643Z","repository":{"id":65803347,"uuid":"599884169","full_name":"jarvanstack/gitbook-summary","owner":"jarvanstack","description":"A Gitbook Summary Generator implemented by Golang","archived":false,"fork":false,"pushed_at":"2024-05-31T03:38:14.000Z","size":37117,"stargazers_count":15,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-06-21T18:06:33.732Z","etag":null,"topics":["dosify","gitbook","gitbook-summary"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jarvanstack.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}},"created_at":"2023-02-10T04:48:22.000Z","updated_at":"2024-05-31T03:38:17.000Z","dependencies_parsed_at":"2024-05-31T04:41:20.471Z","dependency_job_id":"8407c00b-2f53-40e8-8d6a-f1dd178889aa","html_url":"https://github.com/jarvanstack/gitbook-summary","commit_stats":null,"previous_names":["dengjiawen8955/gitbook-summary"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jarvanstack/gitbook-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jarvanstack%2Fgitbook-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jarvanstack%2Fgitbook-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jarvanstack%2Fgitbook-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jarvanstack%2Fgitbook-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jarvanstack","download_url":"https://codeload.github.com/jarvanstack/gitbook-summary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jarvanstack%2Fgitbook-summary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28427039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T16:38:47.836Z","status":"ssl_error","status_checked_at":"2026-01-14T16:34:59.695Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["dosify","gitbook","gitbook-summary"],"created_at":"2026-01-14T16:54:35.945Z","updated_at":"2026-01-14T16:54:36.636Z","avatar_url":"https://github.com/jarvanstack.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## gitbook-summary\n\n[简体中文](README.zh-CN.md)\n\nA Gitbook Summary Generator implemented by Golang\n\n## Example\n\nyour gitbook directory structure:\n\n```bash\n├── docs\n│   ├── 1-ChapterOne\n│   │   ├── 1a-SectionOne.md\n│   │   └── 1b-SectionTwo.md\n│   ├── 2-ChapterTwo\n│   │   ├── 1a-SectionOne.md\n│   │   └── 1b-SectionTwo.md\n│   ├── README.md\n│   ├── _coverpage.md\n│   ├── _media\n│   │   └── icon.svg\n│   ├── _sidebar.md\n│   ├── gitbook-summary.yaml\n│   └── index.html\n```\n\ngitbook-summary.yaml\n\n```yaml\n# 输出的文件 \noutputfile: _sidebar.md\n# 忽略的文件 默认是 .git 和 _\nignores:\n  - _\n# 排序分割符\n# 例如: 10a-如何使用.md, \"10a\" 为排序将会忽略, \"如何使用\" 为标题\n# 排序标题组成为 [数字][字母][排序分隔符][标题].md\nisSort: true\n# 排序分隔符\nsortBy: \"-\"\n# 将文件名转换为标题, 去掉分割符和排序和后缀, 例如: 10a-如何使用.md, \"如何使用\" 为标题, 首字母大写\nisFileNameToTitle: true\n\n```\n\nrun\n\n```bash\n$ cd docs\n$ gitbook-summary \nSummary generate success, output file:  _sidebar.md \n```\n\noutput _sidebar.md\n\n```markdown\n* [README](README.md)\n- [FirstChapter](1-FirstChapter/README.md)\n    * [FirstDocument](1-FirstChapter/1-FirstDocument.md)\n    * [SecondDocument](1-FirstChapter/1a-SecondDocument.md)\n    * [ThirdDocument](1-FirstChapter/2-ThirdDocument.md)\n- SencondChapter\n    * [FirstDocument](1a-SencondChapter/1-FirstDocument.md)\n    * [SecondDocument](1a-SencondChapter/1a-SecondDocument.md)\n    * [ThirdDocument](1a-SencondChapter/2-ThirdDocument.md)\n- ThirdChapter\n    * [FirstDocument](2-ThirdChapter/1-FirstDocument.md)\n\n```\n\n## install\n\n### 1. Use Golang Install\n\n```bash\n$ go install github.com/jarvanstack/gitbook-summary@latest\n```\n\n### 2. Download Binary\n\nrelease:  https://github.com/jarvanstack/gitbook-summary/releases/\n\n## license\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjarvanstack%2Fgitbook-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjarvanstack%2Fgitbook-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjarvanstack%2Fgitbook-summary/lists"}