{"id":21314453,"url":"https://github.com/polyconseil/react-doks","last_synced_at":"2025-07-12T01:31:18.668Z","repository":{"id":65372862,"uuid":"67431698","full_name":"Polyconseil/react-doks","owner":"Polyconseil","description":"React static documentation generator, aimed at merging the development and the documentation workflow","archived":false,"fork":false,"pushed_at":"2016-12-29T14:37:27.000Z","size":2013,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-11-08T19:52:56.844Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://polyconseil.github.io/react-doks/","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/Polyconseil.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":"2016-09-05T15:25:46.000Z","updated_at":"2018-12-02T10:42:51.000Z","dependencies_parsed_at":"2023-01-19T23:35:18.695Z","dependency_job_id":null,"html_url":"https://github.com/Polyconseil/react-doks","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Freact-doks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Freact-doks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Freact-doks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Freact-doks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Polyconseil","download_url":"https://codeload.github.com/Polyconseil/react-doks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225778840,"owners_count":17522710,"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-21T18:13:02.926Z","updated_at":"2024-11-21T18:13:03.550Z","avatar_url":"https://github.com/Polyconseil.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-doks\n\nReact static documentation generator, aimed at merging the development and the documentation workflow.\n\n- Load the component you're working on, develop in isolation, enjoy hot reload\n- Generate static docs and serve them with Github pages (or your own server)\n- Markdown documentation with interactive code examples\n- Automatic props table\n\n## What is it ?\n\nThis tool picks every folder following a certain naming convention (by default, `__docs__`) in a given folder's subtree, and loads every `*.js` file it finds in those folders. Then, it bundles an explorer that allows to browse the docs, with a hot-reload feature when in dev mode to allow developping interactive docs. \n\n## [See it in action](https://polyconseil.github.io/react-doks)\n\n[See an example demo component](https://polyconseil.github.io/react-doks/#Demo/components/WonderfulComponent)\n\n## How to use\n\n### Devserver or static build\n\nDoks has two main working modes :\n- hot reload dev server\n- static docs explorer generation\n\nStart Doks in hot reload mode : \n\n`doks`\n\nStart Doks in \"build\" mode :\n \n`doks --build`\n\n### Folder restriction :\n\nAdditionally, you can provide :\n \n- a specific folder in which Doks should look for documentation, or a single file :  \n`doks src/components/MySuperDuperComponent`\n- a single file to load (this will load Doks without its side menu) :  \n`doks src/components/MySuperDuperComponent/__docs__/aSingleDocsFile.js`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyconseil%2Freact-doks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolyconseil%2Freact-doks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyconseil%2Freact-doks/lists"}