2020-08-19 03:39:41 +08:00
|
|
|
# Code
|
2021-01-25 17:35:52 +08:00
|
|
|
[](https://www.npmjs.com/package/@tiptap/extension-code)
|
|
|
|
|
[](https://npmcharts.com/compare/@tiptap/extension-code?minimal=true)
|
|
|
|
|
|
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-11-18 19:12:34 +08:00
|
|
|
| Option | Type | Default | Description |
|
|
|
|
|
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
|
|
|
|
|
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
2020-08-20 21:33:16 +08:00
|
|
|
## Commands
|
2020-12-04 00:05:22 +08:00
|
|
|
| Command | Parameters | Description |
|
|
|
|
|
| ---------- | ---------- | ------------------------- |
|
|
|
|
|
| setCode | — | Mark text as inline code. |
|
|
|
|
|
| toggleCode | — | Toggle inline code mark. |
|
|
|
|
|
| unsetCode | — | Remove inline code mark. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
2020-09-10 17:24:33 +08:00
|
|
|
## Keyboard shortcuts
|
2021-10-02 05:04:47 +08:00
|
|
|
| Command | Windows/Linux | macOS |
|
|
|
|
|
| ------------ | ------------------ | -------------- |
|
|
|
|
|
| toggleCode() | `Control` `E` | `Cmd` `E` |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
2020-09-21 22:59:28 +08:00
|
|
|
## Source code
|
2021-04-21 21:31:11 +08:00
|
|
|
[packages/extension-code/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)
|
2020-08-19 03:39:41 +08:00
|
|
|
|
2020-09-02 21:26:46 +08:00
|
|
|
## Usage
|
2021-08-26 05:10:20 +08:00
|
|
|
<tiptap-demo name="Marks/Code"></tiptap-demo>
|
