package toc

All checked builds pass
  1. Overview
  2. Docs
A generator of table of contents for Github Markdown files

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (1)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    Thomas Gazagnaire

Sources

toc-0.1.0.tbz
sha256=39b0838e508e1b54bf26c8c32efb2206e726a5ae6aceaafaa26d0df51293ec44
sha512=c34e54770b70f1892c548838f5d123b222c7cfbe17f40a9f9f02663936665d6088200d8282fee0810544dcf94c4bd30861fb72f15680f8f0c955db8c6da0690c

Description

Added to opam-repository:

README

TOC - Manage Tables of Contents in Markdown Files

This repository contains a simple utility to manage tables of contents for Github Markdown files.

Usage

First Use

Run:

$ toc README.md
README.md has been updated.

This will replace any [toc] tokens by the file's table of contents instead.

-[toc]
+<div class="toc">
+
+* [Usage](#Usage)
+  * [First Use](#First-Use)
+  * [Regenerate TOC](#Regenerate-TOC)
+  * [Multiple TOC](#Multiple-TOC)
+  * [Options](#Options)
+    * [Print](#Print)
+    * [Depth](#Depth)
+* [License](#License)
+
+</div>

Regenerate TOC

toc adds transparent <div> markers around the generated table of contents. Hence, the next call to toc will update the table correctly.

To regenerate the TOC, run:

$ toc README.md
README.md has been updated.

Multiple TOC

Use as many [toc] as you like to define multiple table of contents the same file.

Options

Use toc --help to see all the options.

Print
$ toc README.md -p
* Usage
  * First Use
  * Regenerate TOC
  * Multiple TOC
  * Options
    * Print
    * Depth
* License
Depth

Use --depth to control the depth of the table of contents.

$ toc README.md -p -d 1
* Usage
* License

License

ISC. See the LICENSE file.

Dependencies (7)

  1. astring
  2. fmt
  3. logs
  4. cmdliner >= "1.1.0"
  5. omd >= "2.0.0~alpha2"
  6. dune >= "3.5"
  7. ocaml

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building toc with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.1.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure