extension-inline-code

@docs.plus/extension-inline-code

Tiptap mark for inline code (`code`).

It mirrors Tiptap's built-in Code mark — backtick input and paste rules, <code> rendering, Mod-e — and keeps code-mode entry and exit out of the document: a collapsed caret enters through a ProseMirror stored mark, never a placeholder character, and ArrowRight at the document end exits without inserting a space.

Install

bun add @docs.plus/extension-inline-code

Requires @tiptap/core ^3.22.3 and @tiptap/pm ^3.22.3 (Tiptap 3.x).

The 0.x line was monorepo-internal and never published. Upgrading from @tiptap/extension-code? See Migrating and the CHANGELOG.

Quickstart

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import { InlineCode } from '@docs.plus/extension-inline-code'

const editor = new Editor({
  extensions: [
    // Disable StarterKit's built-in `code` mark — see Caveats.
    StarterKit.configure({ code: false }),
    InlineCode
  ]
})

Type between single backticks (`like this`) to format text as inline code; pasted backtick text converts the same way.

Options

Option	Type	Default	Description
HTMLAttributes	Record<string, any>	{}	Attributes merged onto rendered <code> tags.

InlineCode.configure({
  HTMLAttributes: { class: 'my-custom-class' }
})

Commands

Command	Description
setInlineCode()	Apply the mark.
toggleInlineCode()	Toggle the mark.
unsetInlineCode()	Remove the mark.

On a collapsed caret these seed a stored mark, so the next character you type is code — no placeholder character enters the document.

Keyboard shortcuts

Shortcut	Action
Mod-e	Toggle inline code.
ArrowRight	At the end of the document, leave code mode so the next character is plain.

Caveats

• excludes: '_' — applying inline code removes every other mark from the selection (bold, italic, links); code text never stacks other marks. Upstream @tiptap/extension-code parity.
• StarterKit's code mark claims the same <code> tag and Mod-e. InlineCode registers at priority 101 and wins backtick input, paste, and Mod-e; because the marks exclude each other, toggleInlineCode over a code span replaces code with inlineCode — visually identical (both render <code>), but isActive('code') flips to isActive('inlineCode'). Keep the schema to a single <code> mark with StarterKit.configure({ code: false }).
• code: true on the mark spec suppresses other extensions' input rules (typography, bold) inside code spans.
• Mod-e is the only shortcut — Mod-Shift-c was removed in 2.0.0.

Migrating from @tiptap/extension-code

1. StarterKit.configure({ code: false }).
2. Replace toggleCode / setCode with toggleInlineCode / setInlineCode.
3. Drop Mod-Shift-c from docs — only Mod-e remains.

TypeScript

Exports: InlineCode (default), InlineCodeOptions. Commands: setInlineCode, toggleInlineCode, unsetInlineCode.

Family

Sibling packages: extensions/README.md.

Contributing

Bug reports and PRs welcome. Setup, test commands, and the playground harness live in CONTRIBUTING.md.

License

MIT — see LICENSE.