{"id":16065235,"url":"https://github.com/shamin/greenboard","last_synced_at":"2025-04-07T12:01:31.975Z","repository":{"id":35162163,"uuid":"212418081","full_name":"shamin/greenboard","owner":"shamin","description":"📖    Gatsby theme for api documentation ","archived":false,"fork":false,"pushed_at":"2023-01-11T19:41:19.000Z","size":3382,"stargazers_count":249,"open_issues_count":30,"forks_count":21,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T11:01:36.502Z","etag":null,"topics":["api","documentation","gatsby","react"],"latest_commit_sha":null,"homepage":"https://greenboard.surge.sh","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/shamin.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":"2019-10-02T18:54:23.000Z","updated_at":"2025-02-28T11:21:43.000Z","dependencies_parsed_at":"2023-01-15T15:15:14.905Z","dependency_job_id":null,"html_url":"https://github.com/shamin/greenboard","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/shamin%2Fgreenboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shamin%2Fgreenboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shamin%2Fgreenboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shamin%2Fgreenboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shamin","download_url":"https://codeload.github.com/shamin/greenboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648874,"owners_count":20972944,"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":["api","documentation","gatsby","react"],"created_at":"2024-10-09T05:12:02.817Z","updated_at":"2025-04-07T12:01:31.919Z","avatar_url":"https://github.com/shamin.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://greenboard.surge.sh\"\u003e\n    \u003cimg alt=\"Gatsby\" src=\"./logo/logo.png\" width=\"150\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003e\n  Greenboard\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.producthunt.com/posts/greenboard?utm_source=badge-top-post-badge\u0026utm_medium=badge\u0026utm_souce=badge-     greenboard\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=171674\u0026theme=dark\u0026period=daily\" alt=\"Greenboard - Generate beautiful static api documentation  | Product Hunt Embed\" style=\"width: 250px; height: 54px;\" width=\"250px\" height=\"54px\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nCreate beautiful api documentation with gatsby and greenboard\n\n## Features\n- Generate static site from markdown\n- Get all features of gatsby and react\n- Fully customizable\n- Dark Mode\n- Uses same structure of slate docs.\n\n## Installation\n\nSetup your folder and install gatsby, react and react-dom\n```shell\nmkdir my-docs\ncd my-docs\nyarn init\n\nyarn add gatsby react react-dom\n```\n\nInstall greenboard\n```shell\nyarn add gatsby-greenboard\n```\n\n\nThen add gatsby-greenboard to your `gatsby-config.js`. \n\n```javascript\nmodule.exports = {\n  plugins: [\n    {\n      resolve: \"gatsby-greenboard\",\n      options: {},\n    },\n  ],\n}\n```\nNow create your api documentation in `data/index.html.md`. You can check a sample format in [here](./example/data/index.html.md)\n\n\nThat's it, you can now run your gatsby site using\n\n```shell\nyarn gatsby develop\n```\n\nBuild the production files\n\n```shell\nyarn gatsby build\n```\n\n\n## Customization\nTo get more customization fork this repo.\n\nClone the repo\n```shell\nhttps://github.com/shamin/greenboard.git\n```\n\nTravese to the folder\n```shell\ncd greenboard\n```\n\nInstall dependencies\n```shell\nyarn\n```\n\nTo run example locally\n```shell\nyarn workspace example develop\n```\n\nTo build example \n```shell\nyarn workspace example build\n```\n\nTo run the build files locally with serve\n```shell\nnpm install -g serve\n\ncd example/build\nserve\n```\n\nTo deploy example to github pages\n```shell\nyarn workspace example deploy\n```\n\n## FAQs\n### How can I deploy the docs to a non root path\nAdd the `pathPrefix` to `gatsby-config.js` in your docs folder\n```javascript\nmodule.exports = {\n  pathPrefix: `/docs`,\n}\n```\nRun build command\n```\nyarn workspace example build\n```\nFor more information visit https://www.gatsbyjs.org/docs/path-prefix/\n\n## Help\nIf you need some help you can contact me on my email [shamin616@gmail.com](mailto:shamin616@gmail.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshamin%2Fgreenboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshamin%2Fgreenboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshamin%2Fgreenboard/lists"}