2020-08-19 03:39:41 +08:00
|
|
|
|
# CodeBlock
|
2020-09-10 23:29:34 +08:00
|
|
|
|
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.
|
|
|
|
|
|
:::
|
2020-08-20 21:44:08 +08:00
|
|
|
|
|
|
|
|
|
|
## Options
|
2020-09-10 22:54:53 +08:00
|
|
|
|
| Option | Type | Default | Description |
|
|
|
|
|
|
| ------ | ------ | ------- | -------------------------------------------- |
|
|
|
|
|
|
| class | string | – | Add a custom class to the rendered HTML tag. |
|
2020-08-20 21:44:08 +08:00
|
|
|
|
|
|
|
|
|
|
## Commands
|
2020-09-10 22:54:53 +08:00
|
|
|
|
| Command | Options | Description |
|
|
|
|
|
|
| --------- | ------- | ----------------------------- |
|
|
|
|
|
|
| codeBlock | — | Wrap content in a code block. |
|
2020-08-20 21:44:08 +08:00
|
|
|
|
|
2020-09-10 17:24:33 +08:00
|
|
|
|
## Keyboard shortcuts
|
2020-09-10 22:54:53 +08:00
|
|
|
|
* `Shift` + `Control` + `\`
|
|
|
|
|
|
|
|
|
|
|
|
## Source Code
|
|
|
|
|
|
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/)
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
<demo name="Extensions/CodeBlock" highlight="3-5,17,36" />
|
