https://github.com/vimtaai/critic-markup
CriticMarkup in JavaScript
https://github.com/vimtaai/critic-markup
criticmarkup javascript
Last synced: 4 months ago
JSON representation
CriticMarkup in JavaScript
- Host: GitHub
- URL: https://github.com/vimtaai/critic-markup
- Owner: vimtaai
- License: mit
- Created: 2019-05-24T11:42:46.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T23:47:43.000Z (over 1 year ago)
- Last Synced: 2025-10-24T05:04:19.170Z (8 months ago)
- Topics: criticmarkup, javascript
- Language: JavaScript
- Homepage:
- Size: 430 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CriticMarkup
[![License][license-badge]][license-link]
[![Version][version-badge]][version-link]
[![Build][build-badge]][build-link]
Implementation of [CriticMarkup](http://criticmarkup.com/) in JavaScript as a Node.js package/module. It provides functions to parse CriticMarkup syntax or render it into HTML.
## Setup
Install via `npm`:
```bash
npm install critic-markup
```
## Usage
The `critic-markup` package exposes two functions, `parse()` and `render()`. The `parse()` function returns an array of all the CriticMarkup tag occurrences in a string with their most important metadata. The `render()` function replaces all CriticMarkup tags with their HTML equivalent in the input.
```js
import { parse, render } from 'critic-markup';
parse(`Lorem{++ ipsum++} dolor sit amet.`);
// [{
// type: "addition",
// inputText: "Lorem{++ ipsum++} dolor sit amet.",
// matchedText: "{++ ipsum++},
// start: 5,
// end: 17,
// length: 12,
// content: { addition: " ipsum" }
// }]
render(`Lorem{++ ipsum++} dolor sit amet.`);
// Lorem ipsum dolor sit amet.
```
## Contributing
All ideas, recommendations, bug reports, pull requests are welcome. 😊
[license-badge]: https://img.shields.io/npm/l/critic-markup.svg
[license-link]:https://github.com/vimtaai/critic-markup/blob/master/LICENSE.md
[version-badge]: https://img.shields.io/npm/v/critic-markup.svg
[version-link]: https://www.npmjs.com/package/critic-markup
[build-badge]: https://github.com/vimtaai/critic-markup/actions/workflows/main.yaml/badge.svg
[build-link]: https://github.com/vimtaai/critic-markup/actions/workflows/main.yaml