documentation.md

July 15, 2021 · View on GitHub

Bookmarks tagged [documentation]

www.codever.land/bookmarks/t/documentation

Introduction - TypeScript Deep Dive

https://basarat.gitbook.io/typescript/

GitHub - jlevy/the-art-of-command-line: Master the command line, in one page

https://github.com/jlevy/the-art-of-command-line

Master the command line, in one page. Contribute to jlevy/the-art-of-command-line development by creating an account on GitHub.

Docusaurus home page

https://docusaurus.io/

An optimized site generator in React. Docusaurus helps you to move fast and write content. Build documentation websites, blogs, marketing pages, and more.

Antora home page

https://antora.org/

An Asciidoctor documentation toolchain that helps technical teams create, manage, collaborate on, remix, release, and publish documentation sites sourced from multiple versioned repositories.

A minimal approach to software architecture documentation | Dev.to

https://dev.to/simonbrown/a-minimal-approach-to-software-architecture-documentation-4k6k

kylelobo/The-Documentation-Compendium

https://github.com/kylelobo/The-Documentation-Compendium

Various README templates & tips on writing high-quality documentation that people want to read.

Documentation Guide — Write the Docs

https://www.writethedocs.org/guide/

This guide gathers the collective wisdom of the Write the Docs community around best practices for creating software documentation.

Documentation | Guides | Tutorials | Quick Answers | Linode

https://www.linode.com/docs/

Browse Linode's collection of guides, tutorials, and other developer-focused documentation, including quick answers on the Linode platform and Linux.

Use JSDoc: Index

https://jsdoc.app/

Official documentation for JSDoc 3.

CommonMark Home Page

https://commonmark.org/

A strongly defined, highly compatible specification of Markdown

DevDocs API Documentation

https://devdocs.io/

Swagger

http://swagger.io/

Documentation/querying web interface for REST APIs.

raml2html

https://github.com/raml2html/raml2html

Generates HTML documentation from a RAML file.

ReDoc

https://github.com/Rebilly/ReDoc/

OpenAPI/Swagger-powered three-panel documentation.

Slate

https://github.com/lord/slate

Beautiful and responsive three-panel API documentation using Middleman.

Annotate

https://github.com/ctran/annotate_models

Add a comment documenting the current schema to the top or bottom of each of your ActiveRecord models.

Apipie

https://github.com/Apipie/apipie-rails

Rails API documentation and display tool using Ruby syntax.

Asciidoctor

https://asciidoctor.org

A fast, Ruby-based text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook, EPUB3, PDF & more.

Doctor

https://github.com/minio/doctor

Doctor is a Documentation Server for all your docs in github.

Documentation

https://github.com/adamcooke/documentation

A Rails engine to provider the ability to add documentation to a Rails application.

GitHub Changelog Generator

https://github.com/skywinder/github-changelog-generator

Automatically generate change log from your tags, issues, labels and pull requests on GitHub.

Gollum

https://github.com/gollum/gollum

A simple, Git-powered wiki with a sweet API and local frontend.

grape-swagger

https://github.com/ruby-grape/grape-swagger

Add swagger compliant documentation to your Grape API.

Hanna

https://github.com/rdoc/hanna-nouveau

An RDoc formatter built with simplicity, beauty and ease of browsing in mind.

Hologram

https://github.com/trulia/hologram

A markdown based documentation system for style guides. It parses comments in your CSS and helps you turn them into a beautiful style guide.

Inch

https://github.com/rrrene/inch

Inch is a documentation measurement and evalutation tool for Ruby code, based on YARD.

RDoc

https://github.com/ruby/rdoc

RDoc produces HTML and command-line documentation for Ruby projects.

rspec_api_documentation

https://github.com/zipmark/rspec_api_documentation

Automatically generate API documentation from RSpec.

YARD

http://yardoc.org

YARD enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily.

sphinx

https://github.com/sphinx-doc/sphinx/

Python Documentation generator.

awesome-sphinxdoc

https://github.com/yoloseem/awesome-sphinxdoc

A curated list of awesome tools for Sphinx Python Documentation Generator - yoloseem/awesome-sphinxdoc

pdoc

https://github.com/mitmproxy/pdoc

Epydoc replacement to auto generate API documentation for Python libraries.

pycco

https://github.com/pycco-docs/pycco

The literate-programming-style documentation generator.

DevDocs

http://devdocs.io/

Fast, offline, and free documentation browser for developers. Search 100+ docs in one web app: HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C, C++…

styledocco

http://jacobrask.github.io/styledocco/

Ronn

https://github.com/rtomayko/ronn

the opposite of roff. Contribute to rtomayko/ronn development by creating an account on GitHub.

dox

https://github.com/tj/dox

JavaScript documentation generator for node using markdown and jsdoc - tj/dox

jsdox

https://github.com/sutoiku/jsdox

simplified jsdoc 3. Contribute to sutoiku/jsdox development by creating an account on GitHub.

YUIDoc

http://yui.github.io/yuidoc/

coddoc

http://doug-martin.github.io/coddoc/

sphinx

http://www.sphinx-doc.org/

documentation.js

http://documentation.js.org

API documentation generator with support for ES2015+ and flow annotation.

jsduck

https://github.com/senchalabs/jsduck

API documentation generator made for Sencha JavaScript frameworks, but can be used for other frameworks too.

documentation.js

https://github.com/documentationjs/documentation

API documentation generator with support for ES2015+ and flow annotation.

ESDoc

https://github.com/esdoc/esdoc

Documentation generator targeting ES2015, attaching test code and measuring documentation coverage.

Docco

http://jashkenas.github.io/docco/

Documentation generator which produces an HTML document that displays your comments intermingled with your code.

JSDoc

http://usejsdoc.org

API documentation generator similar to JavaDoc or PHPDoc.

mermaid docs

https://mermaidjs.github.io/

Generation of diagrams and flowcharts from text in a similar manner as markdown.

Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?

This is why mermaid...

Graphviz - Graph Visualization Software

https://graphviz.org/

Graphviz is open source graph visualization software. It has several main layout programs. See the gallery for sample layouts. It also has web and interactive graphical interfaces, and auxiliary tools...

Dredd — HTTP API Testing Framework — Dredd latest documentation

https://dredd.org/

Dredd is a language-agnostic command-line tool for validating API description document against backend implementation of the API.

Dredd reads your API description and step by step validates whether y...

API Blueprint home page

https://apiblueprint.org/

API Blueprint is simple and accessible to everybody involved in the API lifecycle. Its syntax is concise yet expressive. With API Blueprint you can quickly design and prototype APIs to be created or d...

SpringFox homepage

http://springfox.github.io/springfox/

Automated JSON API documentation for API's built with Spring

Swagger Editor Home Page

https://editor.swagger.io/

Swagger Editor lets you edit Swagger API specifications in YAML inside your browser and to preview documentations in real time. Valid Swagger JSON descriptions can then be generated and used with the ...

Writing OpenAPI (Swagger) Specification Tutorial - Part 1 - Introduction | API Handyman

https://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-1-introduction/

Previously in the APIverse… Since I started my Swagger journey, there have been some changes. The Swagger Specification has been donated to the newly created OpenAPI Initiative under the Linux foundat...

Welcome | RAMLWelcome | RAML

https://raml.org/

RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It's concise - you only write what you need to define - and reusable. It is machine readabl...

APIDOC - Inline Documentation for RESTful web APIs

http://apidocjs.com/

Generates a RESTful web API Documentation. apiDoc creates a documentation from API annotations in your source code.

@use JSDoc

http://usejsdoc.org/

An API documentation generator for JavaScript.