Question 1

How do I convert markdown to HTML with remark?

Accepted Answer

Use the remark-rehype plugin to transform markdown to an HTML AST, then rehype-stringify to serialize it. For example, combine remarkParse, remarkRehype, and rehypeStringify in a unified pipeline, as shown in the README's first example.

Question 2

Should I use remark or marked for markdown processing?

Accepted Answer

Use remark if you need plugin-based transformations, linting, or AST manipulation. Use marked for simple, fast rendering without custom processing. Remark is better for complex pipelines, while marked is more straightforward for basic HTML output.

Question 3

How can I lint my markdown files with remark?

Accepted Answer

Install plugins like remark-lint or presets such as remark-preset-lint-recommended. Use them in a remark pipeline or via remark-cli to check for consistency and best practices, as demonstrated in the checking markdown example with vfile-reporter.

Question 4

Does remark support GitHub flavored markdown?

Accepted Answer

Yes, through the remark-gfm plugin. It adds support for GFM features like tables, task lists, and strikethrough, as illustrated in the GFM and frontmatter example in the README.

Question 5

How to generate a table of contents in markdown using remark?

Accepted Answer

Use the remark-toc plugin. Configure it in your remark pipeline to automatically insert a table of contents based on headings, with options to customize the heading text, as mentioned in the CLI configuration example.

Question 6

What are some essential plugins for remark beginners?

Accepted Answer

Start with remark-gfm for GFM support, remark-lint for code quality, remark-toc for table of contents, and remark-rehype for HTML conversion. The awesome-remark list provides curated recommendations for popular plugins.

Question 7

Is remark compatible with Deno or other non-Node environments?

Accepted Answer

Yes, remark works universally across JavaScript runtimes including Deno, as stated in the feature highlights. You can use it in any environment that supports ES modules or CommonJS.

remark

What is remark?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions