🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

astro-graphql-plugin

Package Overview
Dependencies
Maintainers
0
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

astro-graphql-plugin

Astro plugin generating Markdown documentation from a GraphQL schema. This plugin is modified off the [docusaurus-graphql-plugin](https://github.com/zhouzi/docusaurus-graphql-plugin) by [Gabin Aureche](https://github.com/zhouzi). If, for some reason, you

0.4.2
latest
Source
npm
Version published
Weekly downloads
343
-14.46%
Maintainers
0
Weekly downloads
 
Created
Source

astro-graphql-plugin

Astro plugin generating Markdown documentation from a GraphQL schema. This plugin is modified off the docusaurus-graphql-plugin by Gabin Aureche. If, for some reason, you need to check commits before version 0.2.0, please see the git history of the previous version.

Usage

  • Install the plugin with the package manager of your choice. For example:

    pnpm add astro-graphql-plugin
    
  • Add the plugin to astro.config.mjs and configure what the source schema, output directory and link prefix (for internal links generated to the output markdown). If you have multiple schemas, define them separately.

    import { defineConfig } from "astro/config";
    
    export default defineConfig({
      integrations: [
        GraphQL({
          schema: "/PATH_TO/schema1.graphql",
          output: "./PATH_TO/output-dir1",
          linkPrefix: "/URL_PATH_TO_GRAPHQL_DOCS_1",
        }),
        GraphQL({
          schema: "/PATH_TO/schema2.graphql",
          output: "./PATH_TO/output-dir2",
          linkPrefix: "/URL_PATH_TO_GRAPHQL_DOCS_2",
        }),
      ],
    });
    

For this plugin, the API documentation is generated on build. If the schema.graphql file or any of the configuration options are updated, run the build step again to see the updates.

Keywords

withastro

FAQs

Package last updated on 30 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts