comment-hole v1.0.0

Getting started

1 Create a hole in your file with comment tags

README.md:

## Options

We support following options:

<!-- <options> -->

<!-- </options> -->

2 Run replaceTag

// scripts/update-readme.js
import { replaceTag } from "comment-hole";

replaceTag("README.md", {
  options: "<<Put anything generated here!>>",
});

node scripts/update-readme.js

3 Done! File will be overwritten

## Options

We support following options:

<!-- <options> -->

+<<Put anything generated here!>>
+
<!-- </options> -->

!NOTE Whenever you run replaceTag ANY content between the hole tags will be replaced.

Supported Extensions

For now we only support .md and .html.
PRs are welcome!