Base project for GraphQL schema HTML documentation generation

---

Base project for GraphQL schema HTML documentation generation using graphdoc and graphdoc plugins with yarn.

It used Github GraphQL schema.

Take a look to the Online generated documentation

(for yarn go to base-graphdoc-yarn)

---

Prerequisites

• Node/Npm.
• Git (only if the project is going to be cloned).

Getting it

In the desired folder, clone the project[1] executing:

git clone https://github.com/gmullerb/base-graphdoc-npm

or

git clone https://gitlab.com/gmullerb/base-graphdoc-npm

[1] Cloning a repository

Running it

package.json script:

• doc: generates GraphQL schema HTML documentation using:
  • graphdoc.
  • graphdoc-plugin-flexible.
  • graphdoc-plugin-operations.
  • graphdoc-plugin-erase.
  • graphdoc-plugin-schema.

  npm run doc

Generated HTMLs will be in folder docs.

---

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.