opensource.guide - Community guides for open source creators

---

Open Source Guides (https://opensource.guide/) are a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project.The first set of Open Source Guides were created and curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products.

open-source oss best-practices tutorial documentation

TypeScript-Handbook - The TypeScript Handbook is a comprehensive guide to the TypeScript language

---

The TypeScript Handbook is a comprehensive guide to the TypeScript language

typescript typescript-handbook documentation learn

DocumentJS - The sophisticated documentation engine

---

DocumentJS creates beautiful, articulate, multi-versioned documentation. With DocumentJS, you can Write documentation inline or in markdown files, Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations, Customize your site's theme and layout, Generate multi-version documentation.

documentation javascript-documentation

DevDocs - API Documentation Browser

---

DevDocs combines multiple API documentations in a fast, organized, and searchable interface.Unless you wish to contribute to the project, I recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box.

devdocs documentation documentation-tool developer-tools docs offline app api-documentation pwa offline-documentation

Zeal - Offline documentation browser inspired by Dash

---

Zeal is an offline documentation browser for software developers.

documentation docset zeal docs api api-documentation offline-documentation devdocs

internals - High level architecture overview

---

This project aims to explain how RabbitMQ works internally. The goal is to make it easier to contribute for newcomers to the project, and at the same time have a common repository of knowledge to be shared across the project contributors.Most interesting modules in RabbitMQ projects have documentation essays, sometimes quite extensive, at the top. The aim here is not to duplicate what's there, but to provide the highest-level overview as to the overall architecture.

rabbitmq internals documentation architecture

dox - JavaScript documentation generator for node using markdown and jsdoc

---

Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

documentation docs markdown jsdoc

webpack.js.org - New repository for webpack documentation and more!

---

Guides, documentation, and all things webpack.We haven't created issues for the other sections yet, but they will be coming soon. For dev-related work please see General - Current Longterm Plan, which will soon be replaced by a more dev-specific issue.

webpack webpack2 webpack-plugin webpack-loader webpack-tutorial documentation docs web web-performance performance bundle bundler bundling nodejs css build tool

reactjs.org - The React documentation website

---

This repo contains the source code and documentation powering reactjs.org.

react website documentation gatsby

Docusaurus - Easy to maintain open source documentation websites.

---

Docusaurus is a project for easily building, deploying, and maintaining open source project websites.Docusaurus is available as the docusaurus package on npm.

documentation website react open-source websites docusaurus

home-assistant.github.io - :blue_book: Jekyll project to generate home-assistant.io

---

This is the source for the Home-Assistant.io website.Setting up to contribute to documentation and the process for submitting pull requests is explained here.

documentation jekyll home-assistant hass hassio

stream-handbook - how to write node programs with streams

---

Now you will have a stream-handbook command that will open this readme file in your $PAGER. Otherwise, you may continue reading this document as you are presently doing.Streams come to us from the earliest days of unix and have proven themselves over the decades as a dependable way to compose large systems out of small components that do one thing well. In unix, streams are implemented by the shell with | pipes. In node, the built-in stream module is used by the core libraries and can also be used by user-space modules. Similar to unix, the node stream module's primary composition operator is called .pipe() and you get a backpressure mechanism for free to throttle writes for slow consumers.

documentation guide handbook stream streams

doctoc - 📜 Generates table of contents for markdown files inside local git repository

---

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites via a command line flag. In its simplest usage, you can pass one or more files or folders to the doctoc command. This will update the TOCs of each file specified as well as of each markdown file found by recursively searching each folder. Below are some examples.

github markdown documentation readme parser bitbucket gitlab ghost

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

---

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.

yard rdoc ruby-documentation yardoc documentation tool

docbox - REST API documentation generator

---

Docbox is an open source REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown. Docbox is a JavaScript application written with React. The core magic is thanks to the remark Markdown parser, which enables the layout: after parsing a file into an Abstract Syntax Tree, we can move examples to the right, prose to the left, and build the navigation system.

api documentation

awesome-coins - ₿ A guide (for humans!) to cryto-currencies and their algos.

---

A cryptocurrency is a digital asset designed to work as a medium of exchange using cryptography to secure the transactions and to control the creation of additional units of the currency. There are many algorithms used in many different crypto–currencies. This document serves to provide a simple map to reference which are for what, as well as provide a nice list of helpful services and utilities for managing coins.

cryptocurrency algorithms bitcoin ethereum awesome awesome-list coin wallet algo nicehash btc guide documentation kennethreitz

elements-of-python-style - Goes beyond PEP8 to discuss what makes Python code feel great

---

This document goes beyond PEP8 to cover the core of what I think of as great Python style. It is opinionated, but not too opinionated. It goes beyond mere issues of syntax and module layout, and into areas of paradigm, organization, and architecture. I hope it can be a kind of condensed "Strunk & White" for Python code. ... but, be flexible on naming and line length.

styleguide python-style pep8 documentation flake8 code-style codestyle

assemble - Get the rocks out of your socks! Assemble makes you fast at creating code projects

---

Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websites / static site generator, alternative to jekyll for gh-pages and more! Assemble can also be used with gulp and grunt.

template-engine build static-site static-site-generator templates scaffold generator scaffolder base toolkit app update generate verb node nodejs gulp grunt assemble async-helper blog boilerplate boilerplates bootstrap builder collection compile component content docs document documentation engines handlebars helper helpers html inflections jekyll layout lodash markdown md page partial post pug render scaffolding site smith static symlink task tasks template templating view views website yaml

http2-explained - A detailed document explaining and documenting HTTP/2, the successor to the widely popular HTTP/1

---

This is a detailed document describing HTTP/2 (RFC 7540), the background, concepts, protocol and something about existing implementations and what the future might hold. The contents are translated into several different languages.

http2 book documentation protocol

iodocs - Interactive API documentation system

---

Copyright 2011-2014 Mashery, Inc. I/O Docs is a live interactive documentation system for RESTful web APIs. By defining APIs at the resource, method and parameter levels in a JSON schema, I/O Docs will generate a JavaScript client interface. API calls can be executed from this interface, which are then proxied through the I/O Docs server with payload data cleanly formatted (pretty-printed if JSON or XML). Basic HTML text tags are enabled in the JSON schema.

livedocs iodocs documentation api