{"id":17312133,"url":"https://github.com/robincsl/gatsby-starter-docz","last_synced_at":"2025-10-18T01:02:12.708Z","repository":{"id":115628794,"uuid":"166583389","full_name":"RobinCsl/gatsby-starter-docz","owner":"RobinCsl","description":"Simple starter where building your own documentation with Docz is possible","archived":false,"fork":false,"pushed_at":"2019-04-11T15:16:56.000Z","size":596,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T03:41:23.834Z","etag":null,"topics":["docz","gatsby-starter","gatsbyjs"],"latest_commit_sha":null,"homepage":"https://gatsby-starter-docz-docz.netlify.com/","language":"CSS","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/RobinCsl.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-19T19:10:34.000Z","updated_at":"2020-01-29T23:38:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe0a87a8-1d48-4acd-84c3-024a1d238005","html_url":"https://github.com/RobinCsl/gatsby-starter-docz","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/RobinCsl%2Fgatsby-starter-docz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobinCsl%2Fgatsby-starter-docz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobinCsl%2Fgatsby-starter-docz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobinCsl%2Fgatsby-starter-docz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RobinCsl","download_url":"https://codeload.github.com/RobinCsl/gatsby-starter-docz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248898739,"owners_count":21179831,"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":["docz","gatsby-starter","gatsbyjs"],"created_at":"2024-10-15T12:42:32.625Z","updated_at":"2025-10-18T01:02:07.673Z","avatar_url":"https://github.com/RobinCsl.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gatsby Starter with Docz\n\nA [GatsbyJS](https://www.gatsbyjs.org/) starter with support for [Docz](https://www.docz.site/).\n\nThis starter is forked from [gatsby-starter-default](https://github.com/gatsbyjs/gatsby-starter-default).\n\nLive Demos:\n\n- Gatsby site: https://gatsby-starter-docz.netlify.com/\n- Docz site: https://gatsby-starter-docz-docz.netlify.com/\n\n## Description\n\nWriting good documentation is important for your project maintainers (and for your future self!). A very nice documentation generator is [Docz](https://www.docz.site). It supports `mdx` files, which is short for Markdown with JSX. That means you can render React components in these special Markdown files. It can generate Prop tables and even provide a coding playground for your components!\n\nThat means you can show and document all your different Gatsby components in a nice and organised way.\n\n\u003e Note: This starter generates the same default Gatsby site as if you just use [gatsby-starter-default](https://github.com/gatsbyjs/gatsby-starter-default).\n\n## Known Limitations\n\nThis starter only works with React components not rendering any `StaticQuery` components from Gatsby. That means any component containing some kind of GraphQL logic cannot be rendered in your documentation files.\n\n## Getting Started\n\nAssuming you have `npx` installed (that is the case if you are using version 5.2.0 or greater of `npm`), run\n\n```\nnpx gatsby-cli new [GATSBY_PROJECT_NAME] https://github.com/RobinCsl/gatsby-starter-docz\n```\n\nYou can then run the Gatsby site with\n\n```\nnpm run develop\n```\n\nand you can go to http://localhost:8000 to see it.\n\nYou can also admire your generated documentation with\n\n```\nnpm run docz:dev\n```\n\nIt will be available at http://localhost:3000.\n\n![](docz/docz-default-screen.png)\n_Showcasing the Header component from Gatsby_\n\nFor more information about writing documentation with Docz, consult their official [guide](https://www.docz.site/introduction).\n\n## Deploying the documentation\n\nTo build the documentation, run\n\n```\nnpm run docz:build\n```\n\nThe resulting build is by default in `.docz/dist`.\n\n## Authors\n\n- Robin Cussol [@RobinCsl](https://github.com/RobinCsl)\n\n## Contributing\n\nTo contribute, follow the usual workflow on GitHub. A great guide is available [here](https://github.com/asmeurer/git-workflow). A TL;DR is:\n\n- Clone the repository\n  ```\n  git clone https://github.com/RobinCsl/gatsby-starter-docz.git\n  ```\n- Fork it to your personal account\n- Add your fork as a remote on the cloned repository\n  ```\n  git remote add \u003cyour username\u003e https://github.com/\u003cyour username\u003e/gatsby-starter-docz.git\n  ```\n- Create your feature branch\n  ```\n  git checkout -b feature/adding-awesomeness\n  ```\n- Commit your changes\n  ```\n  git commit -am 'Feat: Added awesomeness'\n  ```\n- Push to the branch\n  ```\n  git push \u003cyour username\u003e feature/adding-awesomeness\n  ```\n- Create a new Pull Request through GitHub's interface.\n\n### Commit message convention\n\nCommit messages should contain a proper description, once you open a PR it will be added automatically to the PR description.\n\nCommit messages should be prefixed with one of the following to signify the kind of change:\n\n- Fix: bug fixes, e.g. fix some colors, paddings.\n- Feat: new features, e.g. add new component.\n- Refactor: code/structure refactor, e.g. new structure folder for components/ extracting component to separate file.\n- Docs: changes into documentation,\n- Test: adding or updating tests, e.g. unit, snapshot testing.\n- Chore: tooling changes, e.g. change circle ci config.\n- BREAKING: for changes that break existing usage, e.g. change API of a component.\n\nTo make this easier, please run the following command:\n\n```\ngit config --local commit.template commit-template.txt\n```\n\nThis will pre-fill your commit message with a template whenever you run `git commit`, reminding you to follow the convention and to add a summary.\n\n## Licence\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 gatsbyjs\nCopyright (c) 2019 RobinCsl\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobincsl%2Fgatsby-starter-docz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobincsl%2Fgatsby-starter-docz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobincsl%2Fgatsby-starter-docz/lists"}