czytelnik v0.1.1

Czytelnik

Czytelnik (eng. reader) is a CLI tool that generates markdown list with contents of given folder. It is useful for generating table of contents.

• Czytelnik
• Usage
• Commands
• How it is working

Usage

$ npm install -g czytelnik
$ czytelnik COMMAND
running command...
$ czytelnik (-v|--version|version)
czytelnik/0.1.1 darwin-x64 node-v15.3.0
$ czytelnik --help [COMMAND]
USAGE
  $ czytelnik COMMAND
...

Commands

How it is working

Czytelnik reads *.md files inside inputFolder and based on that overrides lists between <!-- CZYTELNIK-START --> and <!-- CZYTELNIK-END --> comments in outputFile (by default README.md).