mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-06-24 04:35:35 +08:00
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# Heading
|
||
The Heading extension adds support for headlines. Headlines are rendered with `<h1>` to `<h6>` HTML tags. By default six headline levels are enabled, but you can pass an array to only allow a few levels, see an example below.
|
||
|
||
Type `# ` at the beginning of a new line and it will be magically transformed to a headline, same for `## `, `### `, `#### `, `##### ` and `###### `.
|
||
|
||
## Options
|
||
| Option | Type | Default | Description |
|
||
| ------ | ------ | ------------------ | -------------------------------------------- |
|
||
| class | string | – | Add a custom class to the rendered HTML tag. |
|
||
| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. |
|
||
|
||
## Commands
|
||
| Command | Options | Description |
|
||
| ------- | ------- | ----------------------- |
|
||
| heading | level | Creates a heading node. |
|
||
|
||
## Keyboard shortcuts
|
||
* `Control` + `Shift` + `1` → H1
|
||
* `Control` + `Shift` + `2` → H2
|
||
* `Control` + `Shift` + `3` → H3
|
||
* `Control` + `Shift` + `4` → H4
|
||
* `Control` + `Shift` + `5` → H5
|
||
* `Control` + `Shift` + `6` → H6
|
||
|
||
## Source Code
|
||
[packages/extension-heading/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/)
|
||
|
||
## Usage
|
||
<demo name="Extensions/Heading" highlight="" />
|