1.2 KiB
1.2 KiB
CodeBlock
With the CodeBlock extension you can add fenced code blocks to your documents. It’ll wrap the code in <pre> and <code> HTML tags.
Type three backticks and a space ``` and a code block is instantly added for you.
::: warning Restrictions The CodeBlock extension doesn’t come with styling and has no syntax highlighting built-in. It’s on our roadmap though. :::
Installation
# With npm
npm install @tiptap/extension-code-block
# Or: With Yarn
yarn add @tiptap/extension-code-block
Settings
| Option | Type | Default | Description |
|---|---|---|---|
| class | string | – | Add a custom class to the rendered HTML tag. |
Commands
| Command | Options | Description |
|---|---|---|
| codeBlock | — | Wrap content in a code block. |
Keyboard shortcuts
Shift+Control+\
Source code
packages/extension-code-block/