All Projects → sergioramos → remark-hint

sergioramos / remark-hint

Licence: other
Sprinkle hints/tips/warnings on your documents

Programming Languages

javascript
184084 projects - #8 most used programming language
HTML
75241 projects
CSS
56736 projects

Projects that are alternatives of or similar to remark-hint

remark-ruby
Custom syntax for remarkjs, adding ruby (furigana) to markdown.
Stars: ✭ 19 (-47.22%)
Mutual labels:  remarkjs, remark-plugin
strip-markdown
plugin remove Markdown formatting
Stars: ✭ 84 (+133.33%)
Mutual labels:  remark, remark-plugin
transformer-oembed
@remark-embedder transformer for oEmbed supported links
Stars: ✭ 25 (-30.56%)
Mutual labels:  remark, remark-plugin
RemarkPortable
Remark made simple and portable
Stars: ✭ 24 (-33.33%)
Mutual labels:  remark, remarkjs
remark-jsx
A simple way to use React inside Markdown.
Stars: ✭ 29 (-19.44%)
Mutual labels:  remark, remarkjs
remark-footnotes
Legacy plugin to add support for pandoc footnotes — please use `remark-gfm` instead
Stars: ✭ 38 (+5.56%)
Mutual labels:  remark, remark-plugin
remark-highlight.js
Legacy plugin to highlight code blocks with highlight.js — please use `rehype-highlight` instead
Stars: ✭ 58 (+61.11%)
Mutual labels:  remark, remark-plugin
remark-behead
Remark plugin to increase or decrease markdown heading weight.
Stars: ✭ 14 (-61.11%)
Mutual labels:  remark, remark-plugin
remark-directive
remark plugin to support directives
Stars: ✭ 137 (+280.56%)
Mutual labels:  remark, remark-plugin
Mdx
Markdown for the component era
Stars: ✭ 11,948 (+33088.89%)
Mutual labels:  remark, mdx
gatsby-remark-images-grid
Use css grid layouts in markdown
Stars: ✭ 22 (-38.89%)
Mutual labels:  remarkjs, remark-plugin
remark-frontmatter
remark plugin to support frontmatter (YAML, TOML, and more)
Stars: ✭ 167 (+363.89%)
Mutual labels:  remark, remark-plugin
remark-license
plugin to generate a license section
Stars: ✭ 15 (-58.33%)
Mutual labels:  remark, remark-plugin
twoslash
You take some Shiki, add a hint of TypeScript compiler, and 🎉 incredible static code samples
Stars: ✭ 596 (+1555.56%)
Mutual labels:  remark, remark-plugin
myPortfolio
This is a portfolio application built by using Next.js, ChakraUi, Typescript and Dev.to api.
Stars: ✭ 127 (+252.78%)
Mutual labels:  remark, mdx
remark-man
plugin to compile markdown to man pages
Stars: ✭ 87 (+141.67%)
Mutual labels:  remark, remark-plugin
remark-slate-transformer
remark plugin to transform remark syntax tree (mdast) to Slate document tree, and vice versa. Made for WYSIWYG markdown editor.
Stars: ✭ 62 (+72.22%)
Mutual labels:  remark, remark-plugin
remark-external-links
Legacy plugin to automatically add target and rel attributes to external links — please use `rehype-external-links` instead
Stars: ✭ 50 (+38.89%)
Mutual labels:  remark, remark-plugin
cache
A cache for @remark-embedder
Stars: ✭ 12 (-66.67%)
Mutual labels:  remark, remark-plugin
remark-bookmarks
plugin to manage links
Stars: ✭ 15 (-58.33%)
Mutual labels:  remark, remark-plugin

remark-hint

Sprinkle hints/tips/warnings on your documents.

installation

yarn add remark-hint

usage

Say we have the following markdown:

!> Here is a tip.

?> And a warning.

x> Or an error.

And our script looks as follows:

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:

<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 of how it looks like.

license

BSD-3-Clause

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].