graphdoc - Static page generator for documenting GraphQL Schema

  •        56

In graphdoc a plugin is simply an object that controls the content that is displayed on every page of your document. This object should only implement the PluginInterface.

https://github.com/2fd/graphdoc#readme
https://github.com/2fd/graphdoc

Dependencies:

@2fd/command : ^1.1.2
bluebird : ^3.5.0
fs-extra : ^0.30.0
glob : ^7.1.0
graphql : ^0.7.0
marked : ^0.3.6
mustache : ^2.2.1
request : ^2.79.0
slug : ^0.9.1
striptags : ^3.0.1
word-wrap : ^1.2.1

Tags
Implementation
License
Platform

   




Related Projects

swagger - Swagger client generator

  •    Javascript

This is a utility for automatically generating API documentation from annotations in Go code. It generates the documentation as JSON, according to the Swagger Spec, and then displays it using Swagger UI.This tool was inspired by Beego, and follows the same annotation standards set by Beego. The main difference between this tool and Beego is that this generator doesn't depend on the Beego framework. You can use any framework to implement your API (or don't use a framework at all). You just add declarative comments to your API controllers, then run this generator and your documentation is ready! For an example of what such documentation looks like when presented via Swagger UI, see the Swagger pet store example.

Wyam - A modular static content and static site generator.

  •    CSharp

Wyam is a simple to use, highly modular, and extremely configurable static content generator that can be used to generate web sites, produce documentation, create ebooks, and much more. Since everything is configured by chaining together flexible modules (that you can even write yourself), the only limits to what it can create are your imagination. For more information see Wyam.io.

ESDoc - Good Documentation for JavaScript

  •    Javascript

ESDoc is a documentation generator for JavaScript. It generates good documentation. It can measure documentation coverage, Integrate test codes into documentation, Parse ECMAScript proposals.

Sphinx - Python Documentation Generator

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python. It also supports C and C++. The support for other languages is in the plan. Support for multiple output formats are supported.


protoc-gen-doc - Documentation generator plugin for Google Protocol Buffers

  •    Go

This is a documentation generator plugin for the Google Protocol Buffers compiler (protoc). The plugin can generate HTML, JSON, DocBook and Markdown documentation from comments in your .proto files. It supports proto2 and proto3, and can handle having both in the same context (see examples for proof).

codox - Clojure documentation tool

  •    Clojure

A tool for generating API documentation from Clojure or ClojureScript source code. This will generate API documentation in the "target/doc" subdirectory (or wherever your project :target-path is set to).

Gatsby - Blazing fast static site generator for React

  •    Javascript

Gatsby is a blazing fast static site generator for React. Gatsby.js is a static PWA (Progressive Web App) generator. You get code and data splitting out-of-the-box. Gatsby loads only the critical HTML, CSS, data, and JavaScript so your site loads as fast as possible. Once loaded, Gatsby prefetches resources for other pages so clicking around the site feels incredibly fast.

appledoc - Objective-c code Apple style documentation set generator.

  •    Objective-C

appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those known to me fall short in meeting the minimum of goals described below. Want to keep updated? Follow us on Twitter - @gentlebytes.

OraDoclet - Database Documentation Generator

  •    HTML

The purpose of OraDoclet is generation of the detailed database documentation resembling the JavaDoc style. It is a custom doclet that functions either with the JavaDoc tool or as a standalone Java application. The documentation generated has a form of static html files and describes all objects in the given Oracle database schema.

pydoctor - Documentation Tool for Python

  •    Python

pydoctor is an API documentation tool for Python. It works by parsing the source code and processing the syntax trees of Python modules and packages, which has advantages and disadvantages over generating the documentation from examining live objects, as some other documentation tools do.

yard - YARD is a Ruby Documentation tool. The Y stands for "Yay!"

  •    Ruby

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. 1. RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. In fact, YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.

vue-styleguidist - Created from react styleguidist for Vue Components with a living style guide

  •    Javascript

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x. Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.

graphql-php - A PHP port of GraphQL reference implementation

  •    PHP

This is a PHP implementation of the GraphQL specification based on the reference implementation in JavaScript. Full documentation is available on the Documentation site as well as in the docs folder of the distribution.

SPDocGen - SharePoint Documentation Generator

  •    

Automatically generate SharePoint Farm Documentation in a few seconds. The application uses the SharePoint Object Model API to produce an XML file containing data from a SharePoint Farm Deployment. The XML file is then transformed into a .doc file (WordML) via XSLT.

doc2dash - Create docsets for Dash.app-compatible API browser.

  •    Python

doc2dash is an MIT-licensed extensible Documentation Set generator intended to be used with the Dash.app API browser for macOS or one of its many free clones for all relevant platforms. doc2dash’s documentation lives at Read the Docs, the code on GitHub. It’s tested on Python 2.7, 3.4+, and PyPy. Both Linux and macOS are tested although certain features are only available on macOS.

gutenberg - A fast static site generator in a single binary with everything built-in.

  •    Rust

A fast static site generator in a single binary with everything built-in. Documentation is available on its site or in the docs/content folder of the repository.

zola - A fast static site generator in a single binary with everything built-in.

  •    Rust

A fast static site generator in a single binary with everything built-in. Documentation is available on its site or in the docs/content folder of the repository and the community can use its forum.