graphdoc-plugin-schema

GraphQL documentation using configurable graphdoc document plugin

---

Quick Start

1 . Add dependencies:

package.json:

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

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

package.json:

{
  "graphdoc-plugin-schema": {
    "documentTitle": "The Description", // default: "Description"
    "extractDescription": false, // default: true
    "enableAssets": false // default: true
  }
}

3 Use graphdoc-plugin-schema:

package.json:

  graphdoc -p graphdoc/../../graphdoc-plugin-schema -s ./schema.GraphQL -o ./build/documentation

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 that document-schema).

Options

package.json:

{
  "graphdoc-plugin-schema": {
    "documentTitle": "Description",
    "extractDescription": true,
    "enableAssets": true
  }
}

• documentTitle: title of the document section.
• extractDescription: if set to false, then description of the type will be inside the "code block".
• 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 is located, using the example created by graphdoc, Pokemon GraphQL:

---

Prerequisites

• "@2fd/graphdoc": "2.4.0".
• "marked": "*".

---

Contributing

• Use it.
• Share it.
• Give it a Star.
• Propose changes or improvements.
• Report bugs.

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.