{"id":17910775,"url":"https://github.com/thebuilder/react-docs-markdown","last_synced_at":"2025-03-23T22:33:07.895Z","repository":{"id":46937151,"uuid":"66927577","full_name":"thebuilder/react-docs-markdown","owner":"thebuilder","description":"Convert the output of react-docgen into markdown","archived":false,"fork":false,"pushed_at":"2022-12-09T02:23:29.000Z","size":1127,"stargazers_count":4,"open_issues_count":22,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-20T04:33:05.392Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thebuilder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-30T09:40:16.000Z","updated_at":"2023-01-13T12:20:58.000Z","dependencies_parsed_at":"2023-01-25T11:45:12.749Z","dependency_job_id":null,"html_url":"https://github.com/thebuilder/react-docs-markdown","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebuilder%2Freact-docs-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebuilder%2Freact-docs-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebuilder%2Freact-docs-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebuilder%2Freact-docs-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thebuilder","download_url":"https://codeload.github.com/thebuilder/react-docs-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221800091,"owners_count":16882479,"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-10-28T19:34:30.358Z","updated_at":"2024-10-28T19:34:31.204Z","avatar_url":"https://github.com/thebuilder.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"React Docs Markdown\n===========================\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/thebuilder/react-docs-markdown.svg)](https://greenkeeper.io/)\n\u003c!-- Build Status --\u003e\n\u003ca href=\"https://travis-ci.org/thebuilder/react-docs-markdown\"\u003e\n  \u003cimg src=\"https://travis-ci.org/thebuilder/react-docs-markdown.svg\" alt=\"Build Status\" /\u003e\n\u003c/a\u003e\n\nAt the moment this is a simple package, that takes the output from [react-docgen](https://github.com/reactjs/react-docgen), and returns it as Markdown. You can then save it to a file, append more content, or whatever you need.\n\n### API\n#### docsToMarkdown(api: object, name: string, options: Object)\n\n* **api** - The output from react-docgen.\n* **name** - Component name to set as page title\n* **options** _(Optional)_\n  * excludeKeys\n  * excludeTypes\n  * excludeDescription\n\n\n### Example\n\n```js\nvar fs = require('fs');\nvar docsToMarkdown = require('react-docs-markdown');\n\nvar md = docsToMarkdown(api, 'Button');\n\n// Use fs to write the markdown to dist\nfs.writeFile('docs/button.md', md, (err) =\u003e {\n  if (err) throw err;\n});\n```\n\n## Publishing\nUse [np](https://www.npmjs.com/package/np) when publishing a new version to ensure everything is done correctly. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebuilder%2Freact-docs-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthebuilder%2Freact-docs-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebuilder%2Freact-docs-markdown/lists"}