Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/privatenumber/comment-mark
Interpolate strings with HTML comment markers!
https://github.com/privatenumber/comment-mark
comment html inject interpolation markdown string
Last synced: 19 days ago
JSON representation
Interpolate strings with HTML comment markers!
- Host: GitHub
- URL: https://github.com/privatenumber/comment-mark
- Owner: privatenumber
- License: mit
- Created: 2020-10-22T06:34:59.000Z (about 4 years ago)
- Default Branch: develop
- Last Pushed: 2021-11-09T05:44:05.000Z (about 3 years ago)
- Last Synced: 2024-10-19T01:11:15.156Z (28 days ago)
- Topics: comment, html, inject, interpolation, markdown, string
- Language: TypeScript
- Homepage:
- Size: 389 KB
- Stars: 25
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# comment-mark [](https://npm.im/comment-mark) [](https://npm.im/comment-mark) [](https://packagephobia.now.sh/result?p=comment-mark) [](https://bundlephobia.com/result?p=comment-mark)
Use comment-mark to insert dynamic content in Markdown/HTML:
1. Prepare Markdown content with placeholders
```js
let markdownString = `
## Last updated
`
```
2. Apply comment-mark to insert data into the placeholders
```js
markdownString = commentMark(markdownString, {
lastUpdated: (new Date()).toISOString()
})
```
3. Done!
```md
## Last updated
2021-02-01T02:48:03.797Z
```
## 🚀 Install
```sh
npm i comment-mark
```
## 🙋♂️ Why?
Most approaches to interpolating dynamic data into a Markdown file involves maintaining a _Markdown template_ as the source, and a build step that produces the actual Markdown file.
Comment-mark lets you use a single Markdown file as both the template and distribution file by using persistent placeholders.
Real examples:
- [My project index](https://github.com/privatenumber/privatenumber) - Auto-renders `projects.json` as a list in `README.md` on Git commit hook
- [minification-benchmarks](https://github.com/privatenumber/minification-benchmarks) - Benchmarking automatically inserts results in `README.md`
## 👨🏻🏫 Quick demo
The following example demonstrates how comment-mark can be used to interpolate a list of the project's Git contributors to `README.md`:
```js
const fs = require('fs')
const { execSync } = require('child_process')
const commentMark = require('comment-mark')
let mdStr = fs.readFileSync('./README.md')
mdStr = commentMark(mdStr, {
contributors: execSync('git shortlog -se HEAD -- .').toString()
})
fs.writeFileSync('./README.md', mdStr)
```
**Before `README.md`**
```md
# Welcome to my project
## Contributors
```
**After `README.md`✨**
```md
# Welcome to my project
## Contributors
17 John Doe
```
## ⚙️ Options
`commentMark(contentStr, data)`
- `contentStr` `` The input string
- `data` - `<{[key: string]: string}>` Key-value pairs to inject into the string
Output: The input string with the key-value pairs from data interpolated in it
## 💁♀️ FAQ
### Why use HTML comments?
This is primarily designed for Markdown files, where basic HTML is typically supported. HTML comment pairs serve as a convenient placeholder to insert a string in between.
### Why are there pairs of HTML comments instead of just one placeholder?
So that the interpolation positions are preserved throughout interpolations.
If there's only one placeholder that gets replaced during interpolation, the placeholder will be lost after the first interpolation. This kind of approach will require a separation of "source" and "distribution" files.