Nefarious Plastic Mannequins

    graphdoc-plugin-schema

    2.0.0 • Public • Published


    GraphQL schema HTML documentation generation, using configurable graphdoc document-schema plugin

    graphdoc-plugin-schema graphdoc-plugin-schema  License   Github repo Gitlab repo


    Quick Start

    1 . Add dependencies:

    package.json:

      "devDependencies": {
        "@2fd/graphdoc": "2.4.0",
        "graphdoc-plugin-schema": "2.0.0",

    2 . If default options are not suitable, then configure graphdoc-plugin-schema:

    package.json:

    {
      "graphdoc-plugin-schema": {
        "documentTitle": "The Description",
        "enableAssets": false
      }
    }

    3 Use graphdoc-plugin-schema:

    package.json:

      "scripts": {
        "doc": "graphdoc -p graphdoc/../../graphdoc-plugin-schema  -p graphdoc/../../graphdoc-plugin-flexible -s ./schema.graphql -o ./build/documentation"
      },
      "graphdoc-plugin-flexible": {
        "document.schema": { "disable": true }
      },
      "devDependencies": {
        "@2fd/graphdoc": "2.4.0",
        "graphdoc-plugin-flexible": "1.0.2",
        "graphdoc-plugin-schema": "2.0.0",

    graphdoc-plugin-flexible is required to avoid duplication when graphdoc default plugins are used.
    graphdoc/../../ this is required to get external plugins working in graphdoc.


    Goals

    graphdoc-plugin-schema provides a way to use graphdoc default document-schema plugin with other custom kinds without breaking (being also faster than document-schema).

    Options

    package.json:

    (default values)

    {
      "graphdoc-plugin-schema": {
        "documentTitle": "Description",
        "enableAssets": true
      }
    }
    • documentTitle: title of the document section.
    • enableAssets: if set to false, then it will disable all the assets provided by the plugin, i.e. script and css files will not be included.

    The following shows where the documentTitle and the "code block" are located, using the example documentation created by graphdoc, Pokemon GraphQL HTML Documentation, using Pokemon GraphQL schema:

    Graphdoc sections

    Using/Configuration

    • To use graphdoc-plugin-schema is necessary that document-schema plugin is disabled (to avoid duplication), use graphdoc-plugin-flexible plugin:

    package.json

      "scripts": {
        "doc": "graphdoc -p graphdoc/../../graphdoc-plugin-schema  -p graphdoc/../../graphdoc-plugin-flexible -s ./schema.graphql -o ./build/documentation"
      },
      "graphdoc-plugin-flexible": {
        "document.schema": { "disable": true }
      },
      "devDependencies": {
        "@2fd/graphdoc": "2.4.0",
        "graphdoc-plugin-flexible": "1.0.2",
        "graphdoc-plugin-schema": "2.0.0",

    Online Examples


    Prerequisites

    graphdoc can work with older versions of GraphQL (description syntax: #), and new versions (description syntax: """), How to configure graphdoc.


    Documentation

    Contributing

    License

    MIT License


    Remember

    • Use code style verification tools => Encourages Best Practices, Efficiency, Readability and Learnability.
    • Code Review everything => Encourages Functional suitability, Performance Efficiency and Teamwork.
    • If viable, Start testing early => Encourages Reliability and Maintainability.

    Additional words

    Don't forget:

    • Love what you do.
    • Learn everyday.
    • Learn yourself.
    • Share your knowledge.
    • Think different!.
    • Learn from the past, dream on the future, live and enjoy the present to the max!.
    • Enjoy and Value the Quest (It's where you learn and grow).

    At life:

    • Let's act, not complain.
    • Be flexible.

    At work:

    • Let's give solutions, not questions.
    • Aim to simplicity not intellectualism.

    Install

    npm i graphdoc-plugin-schema

    DownloadsWeekly Downloads

    78

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    12.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • gmullerb