Open Source Go Documentation Software

A Go project for handling OpenAPI files. We target the latest OpenAPI version (currently 3), but the project contains support for older OpenAPI versions too. Lightweight, blazing fast, cross-platform OpenAPI 3 mock server with validation. Generate Go client and server boilerplate from OpenAPI 3 specifications. Use HTTP/2 Server Push to create fast and idiomatic client-driven REST APIs. Nomad is an easy-to-use, flexible, and performant workload orchestrator that can deploy a mix of microservice, batch, containerized, and non-containerized applications. Nomad is easy to operate and scale and has native Consul and Vault integrations.

terraform-docs is a utility to generate documentation from Terraform modules in various output formats. The terraform-docs configuration file uses the yaml format in order to override any default behaviors. This is a convenient way to share the configuration amongst teammates, CI, or other toolings. Once you set it up and configured it, every time you or your teammates want to regenerate documentation (manually, through a pre-commit hook, or as part of a CI pipeline) all you need to do is run terraform-docs /module/path. One of the most popular format is markdown table, which is a very good fit for generating README of module. terraform-docs is available on Linux, macOS, Windows, and FreeBSD platforms. terraform-docs will locate any available configuration file without needing to explicitly pass the --config flag.

cheat allows you to create and view interactive cheatsheets on the command line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember. Flags may be combined in intuitive ways. Example: to search sheets on the "personal" cheatpath that are tagged with "networking" and match a regex. Cheatsheets are plain-text files with no file extension, and are named according to the command used to view them. Cheatsheet text may optionally be preceded by a YAML frontmatter header that assigns tags and specifies syntax. Cheatsheets are stored on "cheatpaths", which are directories that contain cheatsheets. Cheatpaths are specified in the conf.yml file. It can be useful to configure cheat against multiple cheatpaths. A common pattern is to store cheatsheets from multiple repositories on individual cheatpaths.

A stupid web server for multilingual documentation. Give your users the best documentation experience ever with the ability to instantly change between multiple languages, and remember their preferences! Stop wasting time on worthless waiting! Keep in sync of your documentation in real-time from any Git hosting sources. It is your ultimate right to present the site to your users that is unique to your project. Integrate with popular commenting systems like Disqus, Duoshuo, and let users give you feedback directly without a hitch. Project documentation tools is an already-crowded place yet not both mature and affordable for the individual, especially OSS developers. Countless static site generators, documentation servers, and SaaS products, unfortunately, we are not happy with any of them. More importantly, we love and are capable of hacking on this area.

Docuowl generates static single-page documentation from Markdown files. As a long-time fan of the documentation style made by Stripe, and Markdown, I decided to use the former as a base to create a pretty documentation generator that outputs something like Stripe's. Stripe also generously allowed me to use their layout, so here's a big thank you to them". Docuowl takes a directory as input. The directory is expected to have one directory for each section or group. Each group may have subsections, which by their turn must also be placed into directories. Each Section is required to have content.md file, containing the Frontmatter for that section, and optional sidenotes.md file, that will be rendered to the right of the section. The Frontmatter must contain at least a Title property, and an optional ID property containing a unique slug for that section. Each Group must contain a single meta.md file, containing a Frontmatter like a Section, and an optional content.

jsPolicy runs policies with Google's super fast V8 JavaScript engine in a pool of pre-heated sandbox environments. Most policies do not even take a single millisecond to execute. JavaScript is made for handling and manipulating JSON objects (short for: JavaScript Object Notation!) and Kubernetes uses JSON by converting your YAML to JSON during every API request. Run custom JavaScript controllers that react to any changes to the objects in your cluster (controller policies are reactive, so they are not webhooks and part of a Kubernetes API server request but instead react to Events in your cluster after they have happened). With controller policies you can write resource sync mechanisms, enforce objects in namespaces, garbage collectors or fully functional CRD controllers. Create a functional webhook with a single line of JavaScript or write your own fully blown custom StatefulSet controller in TypeScript with jsPolicy.

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. There is a Docker image available (docker pull pseudomuto/protoc-gen-doc) that has everything you need to generate documentation from your protos. The plugin is invoked by passing the --doc_out, and --doc_opt options to the protoc compiler. The docker image has two volumes: /out and /protos which are the directory to write the documentation to and the directory containing your proto files. By default HTML documentation is generated in /out/index.html for all .proto files in the /protos volume. This can be changed by passing the --doc_opt parameter to the container.