{"id":21713911,"url":"https://github.com/cytle/react-docgen-typescript-markdown-render","last_synced_at":"2026-04-16T04:33:18.870Z","repository":{"id":74068495,"uuid":"298525289","full_name":"cytle/react-docgen-typescript-markdown-render","owner":"cytle","description":"Markdown render for [`react-docgen-typescript`](https://github.com/styleguidist/react-docgen-typescript)","archived":false,"fork":false,"pushed_at":"2020-10-26T06:33:17.000Z","size":289,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T19:31:16.319Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cytle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["jsynowiec"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-09-25T09:16:46.000Z","updated_at":"2024-12-25T12:05:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"14b18f82-6a5f-4da9-b80d-91fb6934ec31","html_url":"https://github.com/cytle/react-docgen-typescript-markdown-render","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cytle/react-docgen-typescript-markdown-render","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytle%2Freact-docgen-typescript-markdown-render","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytle%2Freact-docgen-typescript-markdown-render/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytle%2Freact-docgen-typescript-markdown-render/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytle%2Freact-docgen-typescript-markdown-render/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cytle","download_url":"https://codeload.github.com/cytle/react-docgen-typescript-markdown-render/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytle%2Freact-docgen-typescript-markdown-render/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31871667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"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":[],"created_at":"2024-11-26T00:28:45.209Z","updated_at":"2026-04-16T04:33:18.850Z","avatar_url":"https://github.com/cytle.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jsynowiec"],"categories":[],"sub_categories":[],"readme":"[![TypeScript version][ts-badge]][typescript-4-0]\n[![Node.js version][nodejs-badge]][nodejs]\n[![APLv2][license-badge]][license]\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fcytle%2Freact-docgen-typescript-markdown-render%2Fbadge\u0026style=flat)](https://actions-badge.atrox.dev/cytle/react-docgen-typescript-markdown-render/goto)\n\n# react-docgen-typescript-markdown-render\n\nMarkdown render for [`react-docgen-typescript`](https://github.com/styleguidist/react-docgen-typescript)\n\n## Getting Started\n\n``` sh\nyarn add react-docgen-typescript-markdown-render\n```\n\n``` ts\nimport { markdownRender } from 'react-docgen-typescript-markdown-render';\nimport * as path from 'path';\nimport { parse } from 'react-docgen-typescript';\n\nconst componentDocs = parse('Column.tsx', {\n  savePropValueAsString: true,\n})\nconsole.log(markdownRender(componentDocs));\n```\n\nThe Component [`Column.tsx`](./__tests__/components/Column/Column.tsx)\n\n``` tsx\nimport * as React from \"react\";\nimport { Component } from \"react\";\n\n/**\n * Column properties.\n */\nexport interface IColumnProps {\n  /** prop1 description */\n  prop1?: string;\n  /** prop2 description */\n  prop2: number;\n  /**\n   * prop3 description\n   */\n  prop3: () =\u003e void;\n  /** prop4 description */\n  prop4: \"option1\" | \"option2\" | \"option3\";\n}\n\n/**\n * Form column.\n */\nexport class Column extends Component\u003cIColumnProps\u003e {\n  render() {\n    return \u003cdiv\u003eTest\u003c/div\u003e;\n  }\n}\n```\n\nInto\n\n``` markdown\n### Column\n\nForm column.\n\n#### Props\n\n| Name               | Type                                | Default value | Description              |\n| ------------------ | ----------------------------------- | ------------- | ------------------------ |\n| prop1              | string                              | \"red\"         | prop1 description        |\n| prop2 _(required)_ | number                              |               | prop2 description        |\n| prop3 _(required)_ | () =\u003e void                          |               | prop3 description a \\| b |\n| prop4 _(required)_ | \"option1\" \\| \"option2\" \\| \"option3\" |               | prop4 description 中文   |\n```\n\n## License\n\nLicensed under the APLv2. See the [LICENSE](https://github.com/jsynowiec/node-typescript-boilerplate/blob/master/LICENSE) file for details.\n\n[ts-badge]: https://img.shields.io/badge/TypeScript-4.0-blue.svg\n[typescript-4-0]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html\n[nodejs-badge]: https://img.shields.io/badge/Node.js-\u003e=%2012.13-blue.svg\n[nodejs]: https://nodejs.org/dist/latest-v12.x/docs/api/\n[license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg\n[license]: https://github.com/jsynowiec/node-typescript-boilerplate/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcytle%2Freact-docgen-typescript-markdown-render","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcytle%2Freact-docgen-typescript-markdown-render","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcytle%2Freact-docgen-typescript-markdown-render/lists"}