Skip to content

Commit

Permalink
doc: Add table of contents to README
Browse files Browse the repository at this point in the history
  • Loading branch information
juanibiapina committed Jul 15, 2024
1 parent f0bacc4 commit 28a888a
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,33 @@ It allows the dynamic creation of a CLI from a directory (and subdirectories)
of scripts with support for documentation, argument validation, and
completions.

Use the Github table of contents on the top right of this README to navigate
the documentation.
## Table of Contents

<!-- vim-markdown-toc GFM -->

* [Key features](#key-features)
* [Demo](#demo)
* [Installation](#installation)
* [Setup](#setup)
* [Examples](#examples)
* [As an alias](#as-an-alias)
* [As an executable](#as-an-executable)
* [Usage](#usage)
* [Documenting commands](#documenting-commands)
* [Validating arguments](#validating-arguments)
* [Parsing arguments](#parsing-arguments)
* [Completions](#completions)
* [Nested subcommands](#nested-subcommands)
* [Aliases](#aliases)
* [Sharing code between scripts](#sharing-code-between-scripts)
* [Caching](#caching)
* [Migrating to Sub 2.x](#migrating-to-sub-2x)
* [change --bin to --executable](#change---bin-to---executable)
* [Usage comments](#usage-comments)
* [Help, commands and completions](#help-commands-and-completions)
* [Inspiration](#inspiration)

<!-- vim-markdown-toc -->

## Key features

Expand Down

0 comments on commit 28a888a

Please sign in to comment.