Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

Documentation

Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.

GitHub: https://github.com/topics/documentation
Wikipedia: https://en.wikipedia.org/wiki/Software_documentation
Related Topics: tutorial, man-page, documentation-as-code, docblock, doc-gen, api-documentation, knowledge-base, design-document,
Aliases: docs, documentations, documentation-generator,
Last updated: 2024-11-05 00:08:45 UTC
JSON Representation

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

Master the command line, in one page

bash documentation linux macos unix windows

Last synced: 28 Oct 2024

https://github.com/storybookjs/storybook

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation

angular components design-systems documentation html javascript react react-native stories storybook styleguide svelte testing typescript ui vite vue web-components webpack workshop

Last synced: 01 Nov 2024

https://github.com/storybooks/storybook

Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.

angular components design-systems documentation ember html javascript react react-native storybook styleguide svelte testing typescript ui ui-components vue web-components webpack

Last synced: 02 Aug 2024

https://github.com/mermaid-js/mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

diagrams diagrams-as-code documentation flowchart javascript mindmap typescript uml-diagrams

Last synced: 28 Oct 2024

https://github.com/knsv/mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

diagrams diagrams-as-code documentation flowchart javascript mindmap typescript uml-diagrams

Last synced: 29 Oct 2024

https://github.com/facebook/docusaurus

Easy to maintain open source documentation websites.

documentation hacktoberfest javascript open-source react website

Last synced: 28 Oct 2024

https://github.com/facebook/Docusaurus

Easy to maintain open source documentation websites.

documentation hacktoberfest javascript open-source react website

Last synced: 24 Oct 2024

https://github.com/tldr-pages/tldr

📚 Collaborative cheatsheets for console commands

android bsd cheatsheet cheatsheets command-line console documentation examples hacktoberfest help linux macos man-page manpages manual osx shell terminal tldr windows

Last synced: 28 Oct 2024

https://github.com/charlax/professional-programming

A collection of learning resources for curious software engineers

architecture computer-science concepts documentation engineer learning lessons-learned professional programmer programming-language read-articles scalability software-engineering

Last synced: 29 Oct 2024

https://github.com/chubin/cheat.sh

the only cheat sheet you need

cheatsheet cli command-line curl documentation examples hacktoberfest2021 help terminal tldr

Last synced: 28 Oct 2024

https://github.com/satwikkansal/wtfPython

What the f*ck Python? 😱

documentation gotchas interview-questions pitfalls python python-interview-questions snippets wats wtf

Last synced: 30 Oct 2024

https://github.com/satwikkansal/wtfpython

What the f*ck Python? 😱

documentation gotchas interview-questions pitfalls python python-interview-questions snippets wats wtf

Last synced: 28 Oct 2024

https://github.com/freecodecamp/devdocs

API Documentation Browser

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

Last synced: 28 Oct 2024

https://github.com/freeCodeCamp/devdocs

API Documentation Browser

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

Last synced: 25 Oct 2024

https://github.com/GitbookIO/gitbook

The open source frontend for GitBook doc sites

documentation git gitbook markdown

Last synced: 25 Oct 2024

https://github.com/gitbookio/gitbook

The open source frontend for GitBook doc sites

documentation git gitbook markdown

Last synced: 28 Oct 2024

https://github.com/QingWei-Li/docsify

🃏 A magical documentation site generator.

doc docs docsify documentation documentation-tool github-pages markdown vue

Last synced: 02 Aug 2024

https://github.com/docsifyjs/docsify

🃏 A magical documentation site generator.

doc docs docsify documentation documentation-tool github-pages markdown vue

Last synced: 28 Oct 2024

https://github.com/doczjs/docz

✍ It has never been so easy to document your things!

design-system docs documentation docz gatsby js mdx react theme ui zero-configuration

Last synced: 28 Oct 2024

https://github.com/pedronauck/docz

✍ It has never been so easy to document your things!

design-system docs documentation docz gatsby js mdx react theme ui zero-configuration

Last synced: 04 Aug 2024

https://github.com/requarks/wiki

Wiki.js | A modern and powerful wiki app built on Node.js

cross-platform documentation git markdown nodejs open-source wiki

Last synced: 29 Oct 2024

https://github.com/Requarks/wiki

Wiki.js | A modern and powerful wiki app built on Node.js

cross-platform documentation git markdown nodejs open-source wiki

Last synced: 28 Oct 2024

https://github.com/shimohq/chinese-programmer-wrong-pronunciation

中国程序员容易发音错误的单词

chinese-programmers documentation pronunciation spelling

Last synced: 28 Oct 2024

https://squidfunk.github.io/mkdocs-material/

Documentation that simply works

documentation framework material-design mkdocs plugins theme

Last synced: 03 Nov 2024

https://github.com/squidfunk/mkdocs-material

Documentation that simply works

documentation framework material-design mkdocs plugins theme

Last synced: 28 Oct 2024

https://github.com/mkdocs/mkdocs

Project documentation with Markdown.

documentation markdown mkdocs python static-site-generator

Last synced: 28 Oct 2024

https://github.com/nhnent/tui.editor

🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.

chart commonmark documentation editor frontend gfm html jquery jquery-plugin markdown uml wysiwyg

Last synced: 05 Aug 2024

https://github.com/nhn/tui.editor

🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.

chart commonmark documentation editor frontend gfm html jquery jquery-plugin markdown uml wysiwyg

Last synced: 28 Oct 2024

https://github.com/SimulatedGREG/electron-vue

An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.

babel boilerplate documentation electron electron-builder electron-packager end-to-end-testing es6 unit-testing vue vue-cli webpack

Last synced: 27 Oct 2024

https://github.com/simulatedgreg/electron-vue

An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.

babel boilerplate documentation electron electron-builder electron-packager end-to-end-testing es6 unit-testing vue vue-cli webpack

Last synced: 29 Sep 2024

https://github.com/jsdoc/jsdoc

An API documentation generator for JavaScript.

api docs documentation javascript jsdoc

Last synced: 28 Oct 2024

https://github.com/jsdoc3/jsdoc

An API documentation generator for JavaScript.

api docs documentation javascript jsdoc

Last synced: 04 Aug 2024

https://github.com/BookStackApp/BookStack

A platform to create documentation/wiki content built with PHP & Laravel

bookstack documentation laravel php selfhosted wiki

Last synced: 29 Oct 2024

https://github.com/bookstackapp/bookstack

A platform to create documentation/wiki content built with PHP & Laravel

bookstack documentation laravel php selfhosted wiki

Last synced: 28 Oct 2024

https://github.com/sparanoid/chinese-copywriting-guidelines

Chinese copywriting guidelines for better written communication／中文文案排版指北

chinese chinese-simplified chinese-traditional copywriting css documentation guideline leancloud markdown

Last synced: 29 Oct 2024

https://github.com/github/opensource.guide

📚 Community guides for open source creators

best-practices documentation hacktoberfest open-source oss tutorial

Last synced: 28 Oct 2024

https://github.com/pandao/editor.md

The open source embeddable online markdown editor (component).

codemirror commonmark documentation editor flowchart gfm javascript jquery katex markdown markdown-editor markdown-writer marked sequence-diagram toc

Last synced: 28 Oct 2024

https://github.com/gollum/gollum

A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.

documentation documentation-tool gollum jruby-support markdown ruby wiki

Last synced: 28 Oct 2024

https://github.com/cheat/cheat

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.

bash cheat cheatsheet cheatsheets documentation help interactive-cheatsheets man-page

Last synced: 28 Oct 2024

https://github.com/joelparkerhenderson/architecture-decision-record

Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation

adr architecture-decision-record decision-record decisions documentation project-management teamwork tutorial

Last synced: 15 Oct 2024

https://github.com/zealdocs/zeal

Offline documentation browser inspired by Dash

api api-documentation dash desktop-application developer-tools docs docset documentation documentation-tool offline qt zeal

Last synced: 29 Oct 2024

https://github.com/styleguidist/react-styleguidist

Isolated React component development environment with a living style guide

documentation hacktoberfest react styleguide

Last synced: 28 Oct 2024

https://github.com/sapegin/react-styleguidist

Isolated React component development environment with a living style guide

documentation hacktoberfest react styleguide

Last synced: 04 Aug 2024

https://github.com/reactjs/react.dev

The React documentation website

documentation javascript react website

Last synced: 29 Oct 2024

https://github.com/awsdocs/aws-doc-sdk-examples

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

aws cpp documentation dotnet examples go java javascript php programming python ruby

Last synced: 28 Oct 2024

https://github.com/matheusfelipeog/beautiful-docs

Pointers to useful, well-written, and otherwise beautiful documentation.

beautiful beautiful-docs dev developer doc docs documentation documentations list

Last synced: 14 Oct 2024

https://github.com/mdn/content

The content behind MDN Web Docs

css documentation html http javascript learning mdn reference web-development web-standards

Last synced: 15 Oct 2024

https://github.com/typestrong/typedoc

Documentation generator for TypeScript projects.

documentation generator typescript

Last synced: 28 Oct 2024

https://github.com/TypeStrong/typedoc

Documentation generator for TypeScript projects.

documentation generator typescript

Last synced: 25 Oct 2024

https://consensys.github.io/smart-contract-best-practices/

A guide to smart contract security best practices

blockchain documentation ethereum security smart-contracts solidity

Last synced: 01 Aug 2024

https://github.com/consensys/smart-contract-best-practices

A guide to smart contract security best practices

blockchain documentation ethereum security smart-contracts solidity

Last synced: 13 Oct 2024

https://github.com/Consensys/smart-contract-best-practices

A guide to smart contract security best practices

blockchain documentation ethereum security smart-contracts solidity

Last synced: 24 Oct 2024

https://github.com/ConsenSys/smart-contract-best-practices

A guide to smart contract security best practices

blockchain documentation ethereum security smart-contracts solidity

Last synced: 25 Oct 2024

https://github.com/just-the-docs/just-the-docs

A modern, high customizable, responsive Jekyll theme for documentation with built-in search.

documentation github-pages jekyll jekyll-theme

Last synced: 28 Oct 2024

https://github.com/Kapeli/Dash-iOS

Dash for iOS was discontinued. Please check out Dash for macOS instead.

api app documentation ipad iphone offline

Last synced: 25 Oct 2024

https://github.com/markdoc/markdoc

A powerful, flexible, Markdown-based authoring framework.

authoring documentation markdoc markdown react toolchain

Last synced: 28 Oct 2024

https://github.com/teivah/100-go-mistakes

📖 100 Go Mistakes and How to Avoid Them

book chinese documentation english go golang japanese

Last synced: 29 Oct 2024

https://sysprog21.github.io/lkmpg/

The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)

books c device-driver documentation kernel linux linux-kernel linux-kernel-driver linux-kernel-module lkm lkmpg

Last synced: 01 Aug 2024

https://github.com/sysprog21/lkmpg

The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)

books c device-driver documentation kernel linux linux-kernel linux-kernel-driver linux-kernel-module lkm lkmpg

Last synced: 14 Oct 2024

https://github.com/Unity-Technologies/EntityComponentSystemSamples

auto-vectorisation auto-vectorization burst component containers csharp documentation ecs entity high jobs multicore multicore-processors multicore-programming native performance simd system tutorials unity3d

Last synced: 03 Aug 2024

https://github.com/unity-technologies/entitycomponentsystemsamples

Last synced: 07 Oct 2024

https://github.com/teivah/100-Go-Mistakes

📖 100 Go Mistakes and How to Avoid Them

book chinese documentation english go golang japanese

Last synced: 02 Aug 2024

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

The Sphinx documentation generator

docs documentation documentation-tool markdown python restructuredtext sphinx

Last synced: 28 Oct 2024

https://github.com/tensorflow/docs

TensorFlow documentation

deep-learning deep-neural-networks documentation machine-learning tensorflow tensorflow-examples tensorflow-tutorials

Last synced: 29 Oct 2024

https://github.com/docmost/docmost

Docmost is an open-source collaborative wiki and documentation software. It is an open-source alternative to Confluence and Notion.

confluence documentation knowledge-base notion notion-alternative open-source opensource realtime-collaboration wiki

Last synced: 30 Oct 2024

https://github.com/RichardLitt/standard-readme

A standard style for README files

docs documentation readme readme-standard standard

Last synced: 27 Oct 2024

https://github.com/richardlitt/standard-readme

A standard style for README files

docs documentation readme readme-standard standard

Last synced: 15 Oct 2024

https://github.com/nanotee/nvim-lua-guide

A guide to using Lua in Neovim

documentation guide lua neovim nvim vimscript

Last synced: 28 Sep 2024

https://github.com/documentationjs/documentation

:book: documentation for modern JavaScript

babel documentation documentation-tool javascript jsdoc

Last synced: 28 Oct 2024

https://github.com/race2infinity/the-documentation-compendium

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

awesome docs documentation documentation-template documentation-theme documentation-tool guidelines project-documentation readme readme-bolierplate readme-first readme-md readme-standard readme-template technical-writing template-project templates

Last synced: 25 Sep 2024

https://github.com/raspberrypi/documentation

The official documentation for Raspberry Pi computers and microcontrollers

asciidoc documentation raspberry-pi raspberry-pi-camera raspberry-pi-pico

Last synced: 29 Oct 2024

https://github.com/apachecn/sklearn-doc-zh

:book: [译] scikit-learn（sklearn）中文文档

documentation machine-learning python scikit-learn

Last synced: 13 Oct 2024

https://github.com/home-assistant/home-assistant.io

:blue_book: Home Assistant User documentation

documentation hacktoberfest hass hassio home-assistant jekyll

Last synced: 29 Oct 2024

https://github.com/microsoft/TypeScript-Handbook

Deprecated, please use the TypeScript-Website repo instead

documentation learn typescript typescript-handbook

Last synced: 27 Oct 2024

https://github.com/Microsoft/TypeScript-Handbook

Deprecated, please use the TypeScript-Website repo instead

documentation learn typescript typescript-handbook

Last synced: 24 Oct 2024

https://github.com/codesandbox/sandpack

A component toolkit for creating live-running code editing experiences, using the power of CodeSandbox.

documentation hacktoberfest live-coding playground reactjs sandbox sandpack

Last synced: 28 Oct 2024

https://github.com/microsoft/tsdoc

A doc comment standard for TypeScript

comments doc-comments documentation jsdoc markdown parser rushstack specification syntax typescript

Last synced: 28 Oct 2024

https://github.com/npryce/adr-tools

Command-line tools for working with Architecture Decision Records

architecture architecture-decision-records documentation markdown

Last synced: 29 Oct 2024

https://github.com/ROCm/ROCm

AMD ROCm™ Software - GitHub Home

documentation

Last synced: 30 Oct 2024

https://github.com/withastro/starlight

🌟 Build beautiful, accessible, high-performance documentation websites with Astro

astro docs-generator documentation starlight static-site-generator

Last synced: 28 Oct 2024

https://github.com/knative/docs

User documentation for Knative components.

documentation faas hacktoberfest istio knative kubernetes paas serverless

Last synced: 14 Oct 2024

https://github.com/assemble/assemble

Get the rocks out of your socks! Assemble makes you fast at web development! Used by thousands of projects for rapid prototyping, themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websites/static site generator, an alternative to Jekyll for gh-pages and more! Gulp- and grunt-friendly.

assemble blog-engine build css docs documentation generator grunt gulp html html-templates javascript markdown md nodejs pwa scaffold static-site static-site-generator templates