mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-04 19:59:02 +08:00
42 lines
2.1 KiB
Markdown
42 lines
2.1 KiB
Markdown
# CodeBlock
|
||
[![Version](https://img.shields.io/npm/v/@tiptap/extension-code-block.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-code-block)
|
||
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-code-block.svg)](https://npmcharts.com/compare/@tiptap/extension-code-block?minimal=true)
|
||
|
||
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 <code>``` </code> (three backticks and a space) or <code>∼∼∼ </code> (three tildes and a space) and a code block is instantly added for you. You can even specify the language, try writing <code>```css </code>. That should add a `language-css` class to the `<code>`-tag.
|
||
|
||
::: warning Restrictions
|
||
The CodeBlock extension doesn’t come with styling and has no syntax highlighting built-in. It’s [on our roadmap](/api/nodes/code-block-lowlight) though.
|
||
:::
|
||
|
||
## Installation
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-code-block
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-code-block
|
||
```
|
||
|
||
## Settings
|
||
| Option | Type | Default | Description |
|
||
| ------------------- | -------- | ------------- | --------------------------------------------------------------------- |
|
||
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
||
| languageClassPrefix | `String` | `'language-'` | Adds a prefix to language classes that are applied to code tags. |
|
||
|
||
## Commands
|
||
| Command | Parameters | Description |
|
||
| --------- | ---------- | ----------------------------- |
|
||
| codeBlock | — | Wrap content in a code block. |
|
||
|
||
## Keyboard shortcuts
|
||
* Windows/Linux: `Control` `Alt` `C`
|
||
* macOS: `Cmd` `Alt` `C`
|
||
|
||
## Source code
|
||
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Nodes/CodeBlock"></tiptap-demo>
|