ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

improve extensions documentation, add italic documentation

Browse Source
This commit is contained in:
Hans Pagel
2020-08-20 21:25:15 +02:00
parent 672fe2beab
commit ecd95b8c71
13 changed files with 90 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/src/docPages/api/extensions/bold.md
View File

@@ -2,7 +2,7 @@
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 editor’s initial content, they will all be rendered accordingly.
::: warning Restrictions
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked as bold, regardless of the method will be normalized to `<strong>` HTML tags.
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.
:::
## Options
@@ -11,15 +11,14 @@ The extension will generate the corresponding `<strong>` HTML tags when reading
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| bold | none | Mark text as bold. |
| bold | — | Mark text bold. |
## Keybindings
* Windows & Linux: `Control` + `B`
* macOS: `Command` + `B`
## Usage
<Demo name="Extensions/Bold" />
## Source Code
[packages/extension-bold/index.ts](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/index.ts)
## Usage
<Demo name="Extensions/Bold" highlight="3-5,17,36" />