Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-markdown/graphql-markdown
Flexible GraphQL Documentation Generator (Markdown)
https://github.com/graphql-markdown/graphql-markdown
documentation documentation-generator docusaurus generator gql graphql graphql-config graphql-markdown graphql-schema markdown
Last synced: 28 days ago
JSON representation
Flexible GraphQL Documentation Generator (Markdown)
- Host: GitHub
- URL: https://github.com/graphql-markdown/graphql-markdown
- Owner: graphql-markdown
- License: mit
- Created: 2020-06-12T08:17:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-29T01:46:49.000Z (5 months ago)
- Last Synced: 2024-05-29T02:40:59.771Z (5 months ago)
- Topics: documentation, documentation-generator, docusaurus, generator, gql, graphql, graphql-config, graphql-markdown, graphql-schema, markdown
- Language: TypeScript
- Homepage: https://graphql-markdown.dev
- Size: 13.5 MB
- Stars: 130
- Watchers: 1
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- project-awesome - graphql-markdown/graphql-markdown - Flexible GraphQL Documentation Generator (Markdown) (TypeScript)
README
[](https://graphql-markdown.dev)
Flexible documentation for GraphQL schemas
[](https://www.npmjs.com/package/@graphql-markdown/docusaurus)
[](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)
[](https://plant.treeware.earth/graphql-markdown/graphql-markdown)
[](http://commitizen.github.io/cz-cli/)
This plugin generates **Markdown pages** from a **GraphQL schema** for **Docusaurus** [docs feature](https://docusaurus.io/docs/docs-introduction).
## Installation
**`graphql` package is a peer-dependency, and it should be installed separately.**
```shell
npm install @graphql-markdown/docusaurus graphql
```
Add `@graphql-markdown/docusaurus` to your site's `docusaurus.config.js` plugins option:
```js
module.exports = {
// ...
plugins: ["@graphql-markdown/docusaurus"],
};
```
## Usage
The plugin adds a new command `graphql-to-doc` to the [Docusaurus CLI](https://docusaurus.io/docs/cli).
```shell
npx docusaurus graphql-to-doc
```
Command line options are described in the [documentation settings](https://graphql-markdown.dev/docs/settings) page.
## Configuration
See [documentation configuration](https://graphql-markdown.dev/docs/configuration) page.
## Troubleshooting
See [documentation troubleshooting](https://graphql-markdown.dev/docs/troubleshooting) page.
## License
GraphQL-Markdown packages are 100% free and open-source, under the [MIT license](https://github.com/graphql-markdown/graphql-markdown/blob/main/LICENSE).
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/graphql-markdown/graphql-markdown) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
## Contributions
[Contributions](https://github.com/graphql-markdown/graphql-markdown/blob/main/CONTRIBUTING.md), issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!
