tiptap-commonmark/README.md

A starter-kit for the tiptap editor, based on CommonMark

# Tiptap-Commonmark

> A starter-kit for [the tiptap editor](https://tiptap.dev), based on [CommonMark][cm-spec]

[![install via npm](https://flat.badgen.net/badge/-/NPM/000?scale=1.1&icon=https://icongr.am/octicons/download.svg?color=ff9999&label&labelColor=000)](https://npmjs.com/package/tiptap-commonmark)
[![latest version](https://flat.badgen.net/npm/v/tiptap-commonmark?scale=1.1&label&icon=https://icongr.am/octicons/tag.svg?color=99ffff&color=000&labelColor=000)](https://github.com/binyamin/tiptap-commonmark/releases/latest)
![ESM-ready](https://flat.badgen.net/badge/-/ESM-ready/000?label&labelColor=000&scale=1.1&icon=https://icongr.am/octicons/plug.svg?color=99ff99)

## About

This package bundles a bunch of basic tiptap extensions. It's like tiptap's [official starter-kit](https://tiptap.dev/api/extensions/starter-kit), except that it's based on [the CommonMark specification][cm-spec].

Note that this extension cannot read or write markdown. For that, you can use [`tiptap-markdown`](https://www.npmjs.com/package/tiptap-markdown).

## 💬 Open for Comments

I'd love to hear your thoughts on this project. If you're comfortable, share with me your initial impression via GitHub discussions or email (see my profile).

_Note: I genuinely care about your opinion. Discussion is part of why I love open-source._

## Legal

All source-code is provided under the terms of the [MIT](https://github.com/binyamin/tiptap-commonmark/blob/main/LICENSE) license. Copyright 2021 - 2026 [Binyamin Green](https://binyam.in).

[cm-spec]: https://spec.commonmark.org/0.31.2/