https://github.com/sergioramos/remark-hint

Sprinkle hints/tips/warnings on your documents
https://github.com/sergioramos/remark-hint

html markdown mdx remark remark-plugin remarkjs

Last synced: 17 days ago
JSON representation

Sprinkle hints/tips/warnings on your documents

• Host: GitHub
• URL: https://github.com/sergioramos/remark-hint
• Owner: sergioramos
• Created: 2020-09-03T11:03:25.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-10T03:00:51.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T16:09:32.552Z (about 1 month ago)
• Topics: html, markdown, mdx, remark, remark-plugin, remarkjs
• Language: JavaScript
• Homepage:
• Size: 2.24 MB
• Stars: 43
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# remark-hint

Sprinkle hints/tips/warnings on your documents.

## installation

```bash

yarn add remark-hint

```

## usage

Say we have the following markdown:

```markdown

!> Here is a tip.

?> And a warning.

x> Or an error.

```

And our script looks as follows:

```javascript

const remark = require('remark');

remark()

  .use(require('remark-hint'))

  .use(require('remark-html'))

  .process(src, (err, file) => console.log(String(file)));

```

Now, running it yields:

```html

Here is a tip.

And a waring.

Or an error.

```


> Take a look at [a sample](test/outputs) of how it looks like.

## license

BSD-3-Clause