{"id":16194418,"url":"https://github.com/muniftanjim/gatsby-theme-dox","last_synced_at":"2025-03-16T10:32:35.507Z","repository":{"id":35040447,"uuid":"198269702","full_name":"MunifTanjim/gatsby-theme-dox","owner":"MunifTanjim","description":"Documentation made easy with Gatsby. :tada:","archived":false,"fork":false,"pushed_at":"2023-01-04T21:56:02.000Z","size":4632,"stargazers_count":30,"open_issues_count":23,"forks_count":11,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T01:34:55.451Z","etag":null,"topics":["documentation","gatsby","gatsby-plugin","gatsby-theme"],"latest_commit_sha":null,"homepage":"https://gatsby-theme-dox.netlify.app","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/MunifTanjim.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":"2019-07-22T17:15:14.000Z","updated_at":"2024-09-19T07:01:25.000Z","dependencies_parsed_at":"2023-01-15T12:45:38.467Z","dependency_job_id":null,"html_url":"https://github.com/MunifTanjim/gatsby-theme-dox","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Fgatsby-theme-dox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Fgatsby-theme-dox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Fgatsby-theme-dox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Fgatsby-theme-dox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MunifTanjim","download_url":"https://codeload.github.com/MunifTanjim/gatsby-theme-dox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814907,"owners_count":20352037,"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":["documentation","gatsby","gatsby-plugin","gatsby-theme"],"created_at":"2024-10-10T08:19:16.922Z","updated_at":"2025-03-16T10:32:35.100Z","avatar_url":"https://github.com/MunifTanjim.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dox - Gatsby Theme\n\nA Gatsby theme for creating documentation site.\n\nDocumentation made easy with Gatsby. :tada:\n\n## Features\n\n- :open_book: MDX support\n- :nail_care: Theme UI support\n- :art: Syntax Highlighting\n- :bookmark_tabs: Navbar, Sidebar \u0026 Footer\n- :iphone: Fully Responsive Design :computer:\n\n## Installation\n\nInstall the `gatsby-theme-dox` package:\n\n```sh\n# with npm:\nnpm install --save gatsby-theme-dox\n\n# with yarn:\nyarn add gatsby-theme-dox\n```\n\n## Usage\n\nAdd the `gatsby-theme-dox` pacakge in your `gatsby-config.js` file:\n\n```js\n// gatsby-config.js\nmodule.exports = {\n  siteMetadata: {\n    title: `Dox - Gatsby Theme`,\n    description: 'Documentation made easy with Gatsby',\n    author: 'MunifTanjim'\n  },\n  plugins: [`gatsby-theme-dox`]\n}\n```\n\nYou can also pass a `options` object if you want:\n\n```js\n// gatsby-config.js\nmodule.exports = {\n  plugins: [\n    {\n      resolve: 'gatsby-theme-dox',\n      options: {\n        basePath: '/',\n        contentPath: 'docs'\n      }\n    }\n  ]\n}\n```\n\n## Theme Options\n\n| Key           | Default value  | Description                                                                          |\n| ------------- | -------------- | ------------------------------------------------------------------------------------ |\n| `basePath`    | `/`            | Root URL for the documentation site                                                  |\n| `contentPath` | `content/docs` | Location of documentation files                                                      |\n| `mdx`         | `true`         | Configure `gatsby-plugin-mdx` plugin (if your site already is using it, set `false`) |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuniftanjim%2Fgatsby-theme-dox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuniftanjim%2Fgatsby-theme-dox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuniftanjim%2Fgatsby-theme-dox/lists"}