weave

Overview ¶

The weave command is a simple preprocessor for markdown files. It builds a table of contents and processes %include directives.

Example usage:

$ go run internal/cmd/weave go-api.md > README.md

The weave command copies lines of the input file to standard output, with two exceptions:

If a line begins with "%toc", it is replaced with a table of contents consisting of links to the top two levels of headers ("#" and "##").

If a line begins with "%include FILENAME TAG", it is replaced with the lines of the file between lines containing "!+TAG" and "!-TAG". TAG can be omitted, in which case the delimiters are simply "!+" and "!-".