{"id":19505926,"url":"https://github.com/morlay/react-docgen-ui","last_synced_at":"2025-04-26T02:32:11.031Z","repository":{"id":31373203,"uuid":"34936209","full_name":"morlay/react-docgen-ui","owner":"morlay","description":null,"archived":false,"fork":false,"pushed_at":"2016-08-01T09:53:16.000Z","size":965,"stargazers_count":17,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-15T07:18:39.502Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://morlay.github.io/react-docgen-ui","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/morlay.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}},"created_at":"2015-05-02T04:59:09.000Z","updated_at":"2020-02-27T10:51:50.000Z","dependencies_parsed_at":"2022-09-22T15:02:06.937Z","dependency_job_id":null,"html_url":"https://github.com/morlay/react-docgen-ui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morlay%2Freact-docgen-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morlay%2Freact-docgen-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morlay%2Freact-docgen-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morlay%2Freact-docgen-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morlay","download_url":"https://codeload.github.com/morlay/react-docgen-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250922127,"owners_count":21508279,"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-10T22:34:58.703Z","updated_at":"2025-04-26T02:32:10.688Z","avatar_url":"https://github.com/morlay.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## React DocGen UI\n\n[![Build Status](https://img.shields.io/travis/morlay/react-docgen-ui.svg?style=flat-square)](https://travis-ci.org/morlay/react-docgen-ui)\n[![NPM](https://img.shields.io/npm/v/react-docgen-ui.svg?style=flat-square)](https://npmjs.org/package/react-docgen-ui)\n[![Dependencies](https://img.shields.io/david/morlay/react-docgen-ui.svg?style=flat-square)](https://david-dm.org/morlay/react-docgen-ui)\n[![License](https://img.shields.io/npm/l/react-docgen-ui.svg?style=flat-square)](https://npmjs.org/package/react-docgen-ui)\n\n## How to use\n\nuse gulp to generate `react-doc.json` (react-doc infos with examples) and `react-doc.js` (requires in all example)\n\n```js\n\n    gulp.src([\n      'path/to/components/which/need/to/generate/docs'\n    ])\n      .pipe(gulpDocGenUi({\n        cwd: gutil.env.cwd ? process.cwd() : null\n      }))\n      .on('error', gutil.log.bind(gulp))\n      .pipe(gulp.dest(`path/to/dist`))\n\n```\n\nthen see the example to config and create the doc pages.\n\n## Options\n\n### descriptionCompiler\n\nPass `descriptionCompiler: str =\u003e str` to change the default compiler `marked` on `description` keys in the exported object.\nThis is useful if you want to process the docs further yourself, for example building full markdown documentation pages.\n\n## Change logs\n\n* 0.4.x updated to babel6, if use commonjs, notice the `default` issue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorlay%2Freact-docgen-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorlay%2Freact-docgen-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorlay%2Freact-docgen-ui/lists"}