2020-08-19 03:39:41 +08:00
|
|
|
|
# Code
|
2020-09-02 21:26:46 +08:00
|
|
|
|
The Code extensions enables you to use the `<code>` HTML tag in the editor. If you paste in text with `<code>` tags it will rendered accordingly.
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-23 15:31:05 +08:00
|
|
|
|
Type something with <code>\`back-ticks around\`</code> and it will magically transform to `inline code` while you type.
|
2020-09-15 23:26:35 +08:00
|
|
|
|
|
2020-09-23 15:52:04 +08:00
|
|
|
|
## Installation
|
|
|
|
|
|
```bash
|
2020-10-30 21:24:16 +08:00
|
|
|
|
# with npm
|
2020-09-23 15:52:04 +08:00
|
|
|
|
npm install @tiptap/extension-code
|
|
|
|
|
|
|
2020-10-30 21:24:16 +08:00
|
|
|
|
# with Yarn
|
2020-09-23 15:52:04 +08:00
|
|
|
|
yarn add @tiptap/extension-code
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2020-09-23 18:03:03 +08:00
|
|
|
|
## Settings
|
2020-09-10 16:21:24 +08:00
|
|
|
|
| Option | Type | Default | Description |
|
|
|
|
|
|
| ------ | ------ | ------- | -------------------------------------------- |
|
|
|
|
|
|
| class | string | – | Add a custom class to the rendered HTML tag. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-08-20 21:33:16 +08:00
|
|
|
|
## Commands
|
2020-11-03 23:43:35 +08:00
|
|
|
|
| Command | Parameters | Description |
|
2020-09-10 16:21:24 +08:00
|
|
|
|
| ------- | ------- | ------------------------- |
|
|
|
|
|
|
| code | — | Mark text as inline code. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-10 17:24:33 +08:00
|
|
|
|
## Keyboard shortcuts
|
2020-10-08 19:54:29 +08:00
|
|
|
|
* `Alt` <code>`</code>
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-21 22:59:28 +08:00
|
|
|
|
## Source code
|
2020-09-02 21:26:46 +08:00
|
|
|
|
[packages/extension-code/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/)
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-02 21:26:46 +08:00
|
|
|
|
## Usage
|
2020-11-03 23:43:35 +08:00
|
|
|
|
<demo name="Marks/Code" highlight="3-5,17,36" />
|
