Shell Documentation

Open-source Shell projects categorized as Documentation

Top 20 Shell Documentation Projects

  • standard-readme

    A standard style for README files

    Project mention: Standard Readme | | 2022-11-29
  • adr-tools

    Command-line tools for working with Architecture Decision Records

    Project mention: What tools do you use to plan software features? | | 2022-03-26

    For architectural decisions I have used this in the past:

  • InfluxDB

    Build time-series-based applications quickly and at scale.. InfluxDB is the Time Series Data Platform where developers build real-time applications for analytics, IoT and cloud-native services in less time with less code.

  • security-training

    Public version of PagerDuty's employee security training courses.

    Project mention: PagerDuty Security Training | | 2022-06-23
  • btcpayserver-doc

    BTCPay Server Official Documentation

    Project mention: How do I accept Monero as payment on my company website? | | 2022-05-13

    GH Issue talking about setting it up:

  • terraform-docs-as-pdf

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

    Project mention: Looking for good Terraform resources as PDF's | | 2021-12-06 - this one still produces docs as PDFs nightly.

  • ikea-tradfri-coap-docs

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

    Project mention: Ikea Tradfri 345 GU10 Zigbee bulbs - issue with concurrent transition commands | | 2022-08-10

    HomeAssistant also have a workaround and as far as I can tell from using it HomeKit scenes also work with colour temp and brightness at the same time. Some users report that Ikea Home scenes work as well and giving both commands via COAP works as well -

  • wikiman

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

    Project mention: A tool for managing all documentation | | 2022-05-03
  • SonarLint

    Clean code begins in your IDE with SonarLint. Up your coding game and discover issues early. SonarLint is a free plugin that helps you find & fix bugs and security issues from the moment you start writing code. Install from your favorite IDE marketplace today.

  • jellyfin-docs

    Documentation for Jellyfin

    Project mention: From Plex to Jellyfin Media Server | | 2022-11-12

    I had issues getting it to stream directly to my TV. It wasn't easy to find but what solved it for me was changing the DLNA profile settings like this example:

  • website

    KISS Linux - Website and Documentation (by kisslinux)

  • vale-styles

    Checks for Vale based on popular style guides

  • docs

    Rundeck documentation (by rundeck)

  • 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)

    Project mention: We have launched the first release of Rolling Rhino Remix - A Linux distribution that turns Ubuntu into a rolling release. | | 2022-03-27

    This script looks weird. All those sudos don't do anything useful (echo doesn't need to run as root, and the redirections >> /etc/apt/sources.list are done by the shell, so sudo has no influence on them).

  • crystal-dash-docset

    Dash docset generator for Crystal

  • dotfiles

    My very own dotfiles ✨ (by elamperti)

    Project mention: Any recommended drop down terminal well suited to i3? | | 2022-01-07

    I used Tilda without any problem for years with -I think- this config. Solid terminal. Now I'm using Kitty (so I can display graphs and images in it), this was the base config and I've updated the toggle-terminal script (current version).

  • docs-server

    ownCloud Server Documentation

    Project mention: NextCloud Alternatives: File Sync + CalDav/CardDav | | 2022-08-23
  • udoxy

    Guidelines and script (bash) for generic standalone code documentation

  • PHP-Docs-Builder

    A container to build and run a php/doc-lang repository.

  • tocgen

    Markdown Table of Contents Generator

  • secure-inline-scan-examples

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

    Project mention: How to apply security at the source using GitOps | | 2022-07-27

    Vulnerability scanning. By checking the container images you are using for vulnerabilities before they are deployed in your environment.

  • template.github.semver

    Template for Projects that use Github Actions and Hooks to enforce Semantic Versioning

  • Zigi

    Close all those tabs. Zigi will handle your updates.. Zigi monitors Jira and GitHub updates, pings you when PRs need approval and lets you take fast actions - all directly from Slack! Plus it reduces cycle time by up to 75%.

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 2022-11-29.

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,200
2 adr-tools 3,650
3 security-training 384
4 btcpayserver-doc 303
5 terraform-docs-as-pdf 181
6 ikea-tradfri-coap-docs 174
7 wikiman 147
8 jellyfin-docs 131
9 website 119
10 vale-styles 47
11 docs 37
12 assets 15
13 crystal-dash-docset 13
14 dotfiles 9
15 docs-server 7
16 udoxy 7
17 PHP-Docs-Builder 7
18 tocgen 6
19 secure-inline-scan-examples 5
20 template.github.semver 1
Truly a developer’s best friend
Scout APM is great for developers who want to find and fix performance issues in their applications. With Scout, we'll take care of the bugs so you can focus on building great things 🚀.