mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-12 16:59:01 +08:00
38 lines
2.0 KiB
Markdown
38 lines
2.0 KiB
Markdown
# Heading
|
|
[](https://www.npmjs.com/package/@tiptap/extension-heading)
|
|
[](https://npmcharts.com/compare/@tiptap/extension-heading?minimal=true)
|
|
|
|
The Heading extension adds support for headings of different levels. Headings are rendered with `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>` or `<h6>` HTML tags. By default all six heading levels (or styles) are enabled, but you can pass an array to only allow a few levels. Check the usage example to see how this is done.
|
|
|
|
Type <code># </code> at the beginning of a new line and it will magically transform to a heading, same for <code>## </code>, <code>### </code>, <code>#### </code>, <code>##### </code> and <code>###### </code>.
|
|
|
|
## Installation
|
|
```bash
|
|
# with npm
|
|
npm install @tiptap/extension-heading
|
|
|
|
# with Yarn
|
|
yarn add @tiptap/extension-heading
|
|
```
|
|
|
|
## Settings
|
|
| Option | Type | Default | Description |
|
|
| -------------- | -------- | -------------------- | --------------------------------------------------------------------- |
|
|
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
|
| levels | `Array` | `[1, 2, 3, 4, 5, 6]` | Specifies which heading levels are supported. |
|
|
|
|
## Commands
|
|
| Command | Parameters | Description |
|
|
| ------- | ---------- | ------------------------------------------------ |
|
|
| heading | level | Creates a heading node with the specified level. |
|
|
|
|
## Keyboard shortcuts
|
|
* Windows/Linux: `Control` `Alt` `1-6`
|
|
* macOS: `Cmd` `Alt` `1-6`
|
|
|
|
## Source code
|
|
[packages/extension-heading/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-heading/)
|
|
|
|
## Usage
|
|
<tiptap-demo name="Nodes/Heading"></tiptap-demo>
|