{"id":30281731,"url":"https://github.com/toss/docflow","last_synced_at":"2026-04-02T18:59:51.478Z","repository":{"id":306251543,"uuid":"1025266861","full_name":"toss/docflow","owner":"toss","description":"A TypeScript-first documentation generator from JSDoc comments","archived":false,"fork":false,"pushed_at":"2025-08-01T13:01:13.000Z","size":4648,"stargazers_count":85,"open_issues_count":3,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T04:45:16.278Z","etag":null,"topics":["documentation","jsdoc","typescript"],"latest_commit_sha":null,"homepage":"https://docflow.slash.page/","language":"TypeScript","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/toss.png","metadata":{"files":{"readme":"README-ko_kr.md","changelog":"CHANGELOG.md","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-07-24T02:15:52.000Z","updated_at":"2025-08-08T16:20:51.000Z","dependencies_parsed_at":"2025-07-24T16:34:15.892Z","dependency_job_id":"c6da534b-d913-48ab-a3bf-c4968b6ebcd7","html_url":"https://github.com/toss/docflow","commit_stats":null,"previous_names":["toss/docflow"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/toss/docflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toss%2Fdocflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toss%2Fdocflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toss%2Fdocflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toss%2Fdocflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toss","download_url":"https://codeload.github.com/toss/docflow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toss%2Fdocflow/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270742006,"owners_count":24637499,"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-08-16T02:00:11.002Z","response_time":91,"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":["documentation","jsdoc","typescript"],"created_at":"2025-08-16T16:53:28.255Z","updated_at":"2026-04-02T18:59:51.441Z","avatar_url":"https://github.com/toss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docflow \u0026middot; [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/docflow/blob/main/LICENSE) [![NPM badge](https://img.shields.io/npm/v/docflow?logo=npm)](https://www.npmjs.com/package/docflow)\n\n[English](https://github.com/toss/docflow/blob/main/README.md) | 한국어\n\nDocflow는 JSDoc 주석으로부터 API 문서를 자동으로 생성하는 TypeScript 우선 문서화 도구에요.\n\n- Docflow는 `@public`, `@category`, `@example` 같은 필수 태그를 지원하며, JSDoc 주석에서 포괄적인 문서를 자동으로 생성해요.\n- AI 통합을 염두에 두고 설계된 Docflow는 단일 `@generate` 태그로 함수에 대한 [완전한 JSDoc 주석을 생성](https://docflow.slash.page/ko/command/generate.html)할 수 있어요.\n- Docflow는 정확한 TypeScript 타입 추출을 제공해서 문서가 항상 실제 코드 시그니처와 일치하도록 보장해요.\n- Docflow는 플러그인 시스템을 포함해서 [VitePress](https://vitepress.dev/), [Docusaurus](https://docusaurus.io/), [Nextra](https://nextra.site/) 등의 문서를 생성할 수 있어요.\n\n## 예제\n\n```typescript\nimport { createCalculator } from \"@toss/utils\";\n\n/**\n * @public\n * @category Math\n * 주어진 초기값으로 계산기 인스턴스를 생성합니다\n * @param initialValue - 계산의 시작값\n * @returns 계산 메서드가 포함된 계산기 객체\n * @example\n * const calc = createCalculator(10);\n * calc.add(5).multiply(2).getValue(); // 30\n */\nexport function createCalculator(initialValue: number) {\n  return {\n    add: (n: number) =\u003e createCalculator(initialValue + n),\n    multiply: (n: number) =\u003e createCalculator(initialValue * n),\n    getValue: () =\u003e initialValue,\n  };\n}\n```\n\n단순히 `docflow build`만 실행하면, 예제와 타입 정보 등이 포함된 문서 페이지가 자동으로 생성돼요.\n\n## 기여하기\n\n커뮤니티의 모든 분들의 기여를 환영해요. 자세한 기여 가이드는 아래를 참고해주세요.\n\n[CONTRIBUTING](https://github.com/toss/docflow/blob/main/.github/CONTRIBUTING.md)\n\n## 라이선스\n\nMIT © Toss. 자세한 내용은 [LICENSE](./LICENSE)를 참고하세요.\n\n\u003ca title=\"Toss\" href=\"https://toss.im\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://static.toss.im/logos/png/4x/logo-toss-reverse.png\"\u003e\n    \u003cimg alt=\"Toss\" src=\"https://static.toss.im/logos/png/4x/logo-toss.png\" width=\"100\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoss%2Fdocflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoss%2Fdocflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoss%2Fdocflow/lists"}