tiptap/docs/src/docPages/api/extensions/bold.md

24 lines
876 B
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Bold
2020-08-21 00:15:35 +08:00
This extension is used to render text in **bold**. If you pass `<strong>`, `<b>` tags, or text with inline `style` attributes setting the `font-weight` CSS rule in the editors initial content, they will all be rendered accordingly.
2020-08-19 03:39:41 +08:00
::: warning Restrictions
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked bold, regardless of the method will be normalized to `<strong>` HTML tags.
2020-08-19 03:39:41 +08:00
:::
2020-08-20 21:33:16 +08:00
## Options
2020-08-19 03:39:41 +08:00
*None*
2020-08-20 21:33:16 +08:00
## Commands
| Command | Options | Description |
2020-08-19 03:39:41 +08:00
| ------ | ---- | ---------------- |
| bold | — | Mark text bold. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Keybindings
2020-08-19 03:39:41 +08:00
* Windows & Linux: `Control` + `B`
* macOS: `Command` + `B`
2020-08-21 00:14:41 +08:00
## Source Code
2020-08-21 03:26:25 +08:00
[packages/extension-bold/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)
## Usage
<Demo name="Extensions/Bold" highlight="3-5,17,36" />