Skip to content

graphql-markdown/template

Repository files navigation

GraphQL-Markdown template

Docusaurus template for GraphQL-Markdown.

Quick start

1. Install

npm init docusaurus my-website https://github.com/graphql-markdown/template.git

2. Configure

Update settings in .graphqlrc (see documentation).

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

npm run doc

4. Start

npm start