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
$ intradoc

$ intradoc -f [...files] -d [...data]
$ intradoc [...files] [data]

$ intradoc -f [...files] -d [...data]
$ intradoc [...files] [data]
`

💻 CLI


`
Usage:
$ intradoc
$ intradoc

$ intradoc -f [...files] -d [...data]
$ intradoc [...files] [data]

$ intradoc -f [...files] -d [...data]
$ intradoc [...files] [data]

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][url-contrib-doc].

Thank you!

©️ License

[MIT][url-license-doc] @ Richard King

[url-license-doc]: https://github.com/intradoc/intradoc/blob/main/LICENSE
[url-contrib-doc]: https://github.com/intradoc/intradoc/blob/main/.github/CONTRIBUTING.md