Shell Documentation

Open-source Shell projects categorized as Documentation

Top 23 Shell Documentation Projects

  • standard-readme

    A standard style for README files

  • adr-tools

    Command-line tools for working with Architecture Decision Records

  • InfluxDB

    Collect and Analyze Billions of Data Points in Real Time. Manage all types of time series data in a single, purpose-built database. Run at any scale in any environment in the cloud, on-premises, or at the edge.

  • security-training

    Public version of PagerDuty's employee security training courses.

  • btcpayserver-doc

    BTCPay Server Official Documentation

  • wikiman

    Wikiman is an offline search engine for manual pages, Arch Wiki, Gentoo Wiki and other documentation.

    Project mention: A handful program for offline wiki | /r/Gentoo | 2023-01-12

    So the wiki is down and I start digging some solution for what happen I can’t access wiki when I needed. I found wikiman —a handful cli offline wiki, it’s currently not in repo or any overlay though.

  • terraform-docs-as-pdf

    Complete Terraform documentation (core + all official providers) as PDF files. Updating nightly.

  • ikea-tradfri-coap-docs

    How can you communicate to your ikea tradfri gateway/hub through coap-client

  • Onboard AI

    Learn any GitHub repo in 59 seconds. Onboard AI learns any GitHub repo in minutes and lets you chat with it to locate functionality, understand different parts, and generate new code. Use it for free at

  • HandBrake-docs

    HandBrake Documentation

    Project mention: Costco are sure using a funny naming scheme for their TV demo files | /r/Piracy | 2022-12-12

    Assuming you're looking at Handbrake (a great free frontend for ffmpeg, the actual encoder), you're tuning the quality settings, and the official presets are a good general set of guideposts. Yify tends to put their releases towards the 24-27 range, where artifacts (blockiness or smearing, especially in fast moving or dark areas) are definitely visible in some scenes, but data rates are <3000Kbps for video. This is considerably lower than the scene rules which aim for much higher.

  • website

    KISS Linux - Website and Documentation (by kisslinux)

  • lit

    a little preprocessor for literate programming (by vijithassar)

    Project mention: Literate Programming: Articles | | 2023-05-18

    There are tools to do exactly that, like a simple bash scripts

    I've heard it referred to as 'semi-literate programming' because it skips the reorganization functionality and just gives you nice prose to code conversion.

  • documentation

    eduVPN documentation (by eduvpn)

    Project mention: Best Open Source Scalable VPN Concentrator Solution? | /r/sysadmin | 2023-02-26

    Take a look at Let’s Connect VPN/eduVPN. It’s open source and designed to scale.

  • docs

    Rundeck documentation (by rundeck)

  • vale-styles

    Checks for Vale based on popular style guides

  • opentdf

    Quickstart guide, examples, and documentation repository for OpenTDF, the reference implementation of the Trusted Data Format (TDF). TDF is an object encoding specification that empowers zero-trust security measures by providing end-to-end cryptographic security features with data encryption and tagging.

    Project mention: TDF: Trusted Data Format | | 2023-01-12
  • english

    Base language version of the Tour (by dlang-tour)

    Project mention: D Programming Language | | 2023-12-03

    FYI here are the instructions: (and forum:[email protected]...)

  • crystal-dash-docset

    Dash docset generator for Crystal

  • assets

    This repository is a collection of assets and scripts used in the creation of Rolling Rhino Remix (Ubuntu Desktop Edition). We have a full documented guide on how to create your own disk image of Rolliing Rhino Remix. (by rollingrhinoremix)

  • docs-server

    ownCloud Server Documentation

  • dotfiles

    My very own dotfiles ✨ (by elamperti)

    Project mention: FFmpeg 6.0 | | 2023-02-27

    The manpages are good! I don't use ffmpeg too frequently so, to help myself, I made a cheatsheet (which I update whenever I do something new)

  • secure-inline-scan-examples

    Example code and information about how to use Sysdig inline scan for several integrations

  • docs-ocis

    ownCloud oCis Admin Documentation

    Project mention: I made a guide how to run ownCloud Infinite Scale &amp; OnlyOffice with podman! | /r/SelfHosting | 2023-01-28

    Here is the Link to the guide:

  • udoxy

    Guidelines and script (bash) for generic standalone code documentation

  • tocgen

    Markdown Table of Contents Generator

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020). The latest post mention was on 2023-12-03.

Shell Documentation related posts


What are some of the best open-source Documentation projects in Shell? This list will help you:

Project Stars
1 standard-readme 5,792
2 adr-tools 4,203
3 security-training 399
4 btcpayserver-doc 356
5 wikiman 194
6 terraform-docs-as-pdf 192
7 ikea-tradfri-coap-docs 187
8 HandBrake-docs 168
9 website 122
10 lit 116
11 documentation 70
12 docs 56
13 vale-styles 46
14 opentdf 39
15 english 28
16 crystal-dash-docset 15
17 assets 15
18 docs-server 12
19 dotfiles 11
20 secure-inline-scan-examples 8
21 docs-ocis 7
22 udoxy 7
23 tocgen 6
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives