{"id":19857696,"url":"https://github.com/markmur/docky","last_synced_at":"2025-05-02T02:30:39.437Z","repository":{"id":57214106,"uuid":"53348125","full_name":"markmur/docky","owner":"markmur","description":"Generate documentation for React components","archived":false,"fork":false,"pushed_at":"2018-01-08T10:26:43.000Z","size":1822,"stargazers_count":3,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-06T21:05:35.747Z","etag":null,"topics":["cli","components","docgen","docky","documentation","react"],"latest_commit_sha":null,"homepage":"http://markmur.github.io/docky/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markmur.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}},"created_at":"2016-03-07T18:22:12.000Z","updated_at":"2018-05-10T21:18:52.000Z","dependencies_parsed_at":"2022-08-26T13:31:02.387Z","dependency_job_id":null,"html_url":"https://github.com/markmur/docky","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmur%2Fdocky","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmur%2Fdocky/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmur%2Fdocky/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmur%2Fdocky/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markmur","download_url":"https://codeload.github.com/markmur/docky/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251972418,"owners_count":21673600,"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":["cli","components","docgen","docky","documentation","react"],"created_at":"2024-11-12T14:19:29.038Z","updated_at":"2025-05-02T02:30:38.372Z","avatar_url":"https://github.com/markmur.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/markmur/docky/raw/master/docs/images/docky.png?raw=true\" width=\"150\" alt=\"Docky\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\n  Docky\n\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  Generate Documentation for React Components.\n\u003c/p\u003e\n\nDocky is a tool for generating documentation for React component libraries. It works by reading a specified README (optional) and directory of components and parsing the components and their comments, using [react-docgen](https://github.com/reactjs/react-docgen).\n\nIf a Readme file is specified, Docky will auto-parse the h2 (##) headers and add them to the sidebar with relative links to the page content.\n\n[View Demo](http://markmur.github.io/docky/)\n\n\n## Example Component\n\n```javascript\nimport React, { Component, PropTypes } from 'react';\n\n/**\n * Some general description of your component\n */\nclass App extends Component {\n  render = ({ className, children }) =\u003e (\n    \u003cmain className={className}\u003e\n      {children}\n    \u003c/main\u003e\n  )\n}\n\nApp.propTypes = {\n  /**\n   * Description of prop type\n   */\n  children: PropTypes.any.isRequired,\n  /**\n   * Description of prop type\n   */\n  className: PropTypes.string.isRequired\n};\n\n```\n\n## CLI Usage\n\nInstall docky globally:\n\n```shell\nnpm install -g docky\n```\n\nRun docky on a single file or entire folder:\n\n```bash\ndocky src/components/**/*.js\n```\n\n### Example Usage with Options\n\n```bash\ndocky src/components/**/*.js \\ # specify the components to parse\n  --watch \"src/components/**/*.js\",\"./README.md\" \\ # watch files\n  --ignore \"src/components/**/index.js\" \\ # ignored files\n  --use-readme=false\n```\n\n\u003e Tip: to avoid retyping the command every time, add it to an NPM script in in your package.json\n\n### Options\n\n```bash\nUsage: docky [files] [options]\n\nOptions:\n\n-h, --help              output usage information\n-V, --version           output the version number\n-c, --color \u003cHEX\u003e       Change the primary theme color (defaults to blue)\n-w, --watch \"\u003cfiles\u003e\"   Watch specific files and compile on change (comma separate directories/files to watch multiple)\n-i, --ignore \"\u003cfiles\u003e\"  Ignore specified files from docs\n--use-readme [bool]     include/omit README from your documentation (defaults to true)\n\n\n```\n\n## Contributing\n\nDocky uses Pug (formally known as Jade) and SASS for template generation. The files can be found under the `template` directory.\n\nThere is a `components` directory which contains some example React components for testing. You can run docky over the local folder by running:\n\n```shell\nnpm run docs\n```\n\nTo compile the sass, run:\n```shell\nnpm run sass\n```\n\n### Live Reload Compilation\n\nTo auto-compile the docs on change, use the `npm start` command which will start BrowserSync (for live reloading), SASS --watch (for regenerating csss) and Docky --watch (for re-compilation).\n\n### Thanks\n\nThis tool relies heavily on the [react-docgen](https://github.com/reactjs/react-docgen) project by the reactjs team so many thanks to those who have made Docky possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkmur%2Fdocky","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkmur%2Fdocky","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkmur%2Fdocky/lists"}