https://github.com/graphql-markdown/template
Docusaurus template for GraphQL-Markdown
https://github.com/graphql-markdown/template
documentation-generator docusaurus docusaurus-template docusaurus2 graphql markdown template
Last synced: 18 days ago
JSON representation
Docusaurus template for GraphQL-Markdown
- Host: GitHub
- URL: https://github.com/graphql-markdown/template
- Owner: graphql-markdown
- License: mit
- Created: 2022-09-24T15:49:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T04:55:54.000Z (24 days ago)
- Last Synced: 2025-05-05T07:15:49.839Z (18 days ago)
- Topics: documentation-generator, docusaurus, docusaurus-template, docusaurus2, graphql, markdown, template
- Language: JavaScript
- Homepage: https://graphql-markdown.dev
- Size: 1.56 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GraphQL-Markdown template
Docusaurus template for [GraphQL-Markdown](https://graphql-markdown.dev).
## Quick start
**1. Install**
```shell
npm init docusaurus my-website https://github.com/graphql-markdown/template.git
```
**2. Configure**
Update settings in `.graphqlrc` (see [documentation](https://graphql-markdown.dev/docs/configuration#graphql-config)).
```yaml
schema: 'https://api.react-finland.fi/graphql'
extensions:
graphql-markdown:
baseURL: '.'
homepage: 'static/index.md'
loaders:
UrlLoader: '@graphql-tools/url-loader'
docOptions:
pagination: false
printTypeOptions:
deprecated: 'group'
```
**3. Generate**
```shell
npm run doc
```
**4. Start**
```shell
npm start
```