Giter Club home page Giter Club logo

intradoc


release-badge ci-badge coverage-badge dependency-badge release-workflow-badge

code-style-badge commit-style-badge release-workflow-badge

license-badge contribution-badge


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

đŸģ Contribution

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

Thank you!

Šī¸ License

MIT @ Richard King

intradoc's Projects

intradoc icon intradoc

In-place document content replacer CLI utility.

media icon media

Monorepo of graphical assets and website of @intradoc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤ī¸ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.