intradoc

intradoc

Update your docs in-place.

A simple, in-place document content replacer CLI utility,
which works by replacing placeholder texts within your files.

🤔 Why?

• Keep your documents up-to-date during the SDLC, especially during releases without creating additional or separate in-between and temp files.
• Avoid errors and improve consistency by using simple comment placeholders and populate them with new data.
• Save time and effort by automating the process of replacing API, usage, and other information within your files instead of you updating them manually.

📦 Installation

npm i intradoc

☕ Usage

$ intradoc <flags> <input>
$ intradoc <input> <flags>

$ intradoc <flags> -f [...files] -d [...data]
$ intradoc <flags> [...files] [data]

$ intradoc -f [...files] -d [...data] <flags>
$ intradoc [...files] [data] <flags>

💻 CLI

Usage:
  $ intradoc <flags> <input>
  $ intradoc <input> <flags>

  $ intradoc <flags> -f [...files] -d [...data]
  $ intradoc <flags> [...files] [data]

  $ intradoc -f [...files] -d [...data] <flags>
  $ intradoc [...files] [data] <flags>

Examples:
  $ intradoc -f README.md -d data.json

  $ intradoc README.md data.yml

Options:
  -f, --file, --files   file(s) to process
  -d, --data            data to use

  -v, --version   output the version number
  -h, --help      display help for intradoc

⭐ Related

• @intradoc on NPM

🍻 Contribution

Any contribution is highly appreciated. To get going, check out the contribution guidelines.

Thank you!

©️ License

MIT @ Richard King