Git Product home page Git Product logo

graphqlmd's Introduction

GraphGLmd

This gem will generate markdown by your GraphQL schema

Usage

graphqlmd -u GRAPHQL_ENDPOINT_URL > schema.md

Options


Usage: graphqlmd [options]
    -u, --url [URL]                  GraphQL schema url (default: http://localhost:3000/graphql)
    -t, --title [TITLE]              Title (default: GraphQL API)
        --note [NOTE]                Text after title (default: nil)
        --no-deprecated              Do not add deprecated objects, fields, args and etc.
        --no-links                   Do not add links with anchors to docs
        --no-table-of-contents       Do not add table of contents
        --client-mutation-id         Add clientMutationId to docs
        --scalar                     Add scalar objects to docs
        --vuepress                   Use vuepress additional styles
        --ignored-queries a,b,c      List of ignored and skipped Queries
        --ignored-mutations a,b,c    List of ignored and skipped Mutations
        --ignored-objects a,b,c      List of ignored and skipped Objects
    -v, --version                    Show version
    -h, --help                       Show this message

Installation

gem install graphqlmd

Sponsors

graphqlmd's People

Contributors

blackchestnut avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.