# remark-hint

> Sprinkle hints/tips/warnings on your documents

Latest version **1.0.10** (published 2021-03-30) · 0 weekly downloads

## Install

```sh
npm install remark-hint
pnpm add remark-hint
yarn add remark-hint
bun add remark-hint
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2021-03-30 |
| First published | 2020-09-03 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/remark-hint) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 43 |
| Maintainers | ramitos |
| Keywords | markdown, remark, remarkjs, remark-plugin, hint, tip, warning, error, html |

## Links

- npm: https://www.npmjs.com/package/remark-hint
- Repository: https://github.com/sergioramos/remark-hint
- Homepage: https://github.com/sergioramos/remark-hint#readme
- Issues: https://github.com/sergioramos/remark-hint/issues
- npm.io page: https://npm.io/package/remark-hint

## Dependencies (1)

- [unist-builder](https://npm.io/package/unist-builder.md) ^2.0.3

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.10 (latest) — 2021-03-30
- 1.0.9 — 2020-11-14
- 1.0.8 — 2020-10-16
- 1.0.7 — 2020-10-16
- 1.0.6 — 2020-10-08
- 1.0.5 — 2020-09-24
- 1.0.4 — 2020-09-16
- 1.0.3 — 2020-09-14
- 1.0.2 — 2020-09-14
- 1.0.1 — 2020-09-08
- 1.0.0 — 2020-09-03

## 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
<p class="hint tip">Here is a tip.</p>
<p class="hint warn">And a waring.</p>
<p class="hint error">Or an error.</p>
```

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

## license

BSD-3-Clause

---
_Source: https://npm.io/package/remark-hint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._