Announcing clap-markdown — automatically generate Markdown docs for clap command-line tools

This page summarizes the projects mentioned and recommended in the original post on /r/rust

Our great sponsors
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • SaaSHub - Software Alternatives and Reviews
  • bpaf

    Command line parser with applicative interface

  • bpaf does it here, giving access to primitives like "dump names of this parser" or "dump help for this subparser": https://github.com/pacak/bpaf/blob/semantic/src/docugen.rs

  • clap-markdown

    Autogenerate Markdown documentation for clap command-line tools

  • The result was clap-markdown.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
  • wolfram-app-discovery-rs

    Locate local installations of the Wolfram Language.

  • wolfram-app-discovery — CommandLineHelp.md

  • wolfram-cli

    Unofficial Wolfram command-line interface.

  • wolfram-cli — CommandLineHelp.md

  • clap-md

    Generate Markdown documentation for clap application definitions

  • Note: This project has no relation to the clap-md project, which seems to have been an earlier attempt at a tool like this.

  • clap-rs

    A full featured, fast Command Line Argument Parser for Rust

  • As an alternative to trying to re-create clap's help logic (whether its help headings, sorting, etc), I've been playing with the idea for separate information collecting from rendering which would allow a lot of code to be reused between man pages, md, etc.

  • semantic

    semantic documentation builder (by pacak)

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • cargo-show-asm

    cargo subcommand showing the assembly, LLVM-IR and MIR generated for Rust code

  • https://github.com/pacak/cargo-show-asm/tree/semantic - how all of this is used

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts