mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-04 19:59:02 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
377bbb177d
tiptap/docs/api/nodes/code-block.md

42 lines
2.1 KiB
Markdown
Raw Normal View History

move all extensions to separate pages
2020-08-19 03:39:41 +08:00
# CodeBlock
docs: add badges to all extensions
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-code-block.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-code-block)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-code-block.svg)](https://npmcharts.com/compare/@tiptap/extension-code-block?minimal=true)
update the code block page, add tests
2020-09-10 23:29:34 +08:00
With the CodeBlock extension you can add fenced code blocks to your documents. It’ll wrap the code in `<pre>` and `<code>` HTML tags.
update the documentation
2020-10-02 21:12:01 +08:00
Type <code>&grave;&grave;&grave;&nbsp;</code> (three backticks and a space) or <code>&Tilde;&Tilde;&Tilde;&nbsp;</code> (three tildes and a space) and a code block is instantly added for you. You can even specify the language, try writing <code>&grave;&grave;&grave;css&nbsp;</code>. That should add a `language-css` class to the `<code>`-tag.
update the code block page, add tests
2020-09-10 23:29:34 +08:00
::: warning Restrictions
docs: update content
2021-04-03 21:21:30 +08:00
The CodeBlock extension doesn’t come with styling and has no syntax highlighting built-in. It’s [on our roadmap](/api/nodes/code-block-lowlight) though.
update the code block page, add tests
2020-09-10 23:29:34 +08:00
:::
improve extensions documentation
2020-08-20 21:44:08 +08:00
add installation instructions to all extensions
2020-09-23 15:52:04 +08:00
## Installation
```bash
update content
2020-10-30 21:24:16 +08:00
# with npm
add installation instructions to all extensions
2020-09-23 15:52:04 +08:00
npm install @tiptap/extension-code-block
update content
2020-10-30 21:24:16 +08:00
# with Yarn
add installation instructions to all extensions
2020-09-23 15:52:04 +08:00
yarn add @tiptap/extension-code-block
```
a ton of improvements
2020-09-23 18:03:03 +08:00
## Settings
docs: add HTMLAttributes
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. |
| languageClassPrefix | `String` | `'language-'` | Adds a prefix to language classes that are applied to code tags. |
improve extensions documentation
2020-08-20 21:44:08 +08:00
## Commands
move everything around, add more content and a first test for images
2020-11-03 23:43:35 +08:00
| Command | Parameters | Description |
| --------- | ---------- | ----------------------------- |
| codeBlock | — | Wrap content in a code block. |
improve extensions documentation
2020-08-20 21:44:08 +08:00
rename keybindings to keyboard shortcuts
2020-09-10 17:24:33 +08:00
## Keyboard shortcuts
rework keyboard shortcuts
2020-11-19 08:16:10 +08:00
* Windows/Linux: `Control`&nbsp;`Alt`&nbsp;`C`
* macOS: `Cmd`&nbsp;`Alt`&nbsp;`C`
rename the code block extension, add content to the code block extension
2020-09-10 22:54:53 +08:00
minor improvements
2020-09-21 22:59:28 +08:00
## Source code
replace link to GitHub repository
2021-04-21 21:31:11 +08:00
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block/)
rename the code block extension, add content to the code block extension
2020-09-10 22:54:53 +08:00
## Usage
replace demo component with custom element
2021-08-26 05:10:20 +08:00
<tiptap-demo name="Nodes/CodeBlock"></tiptap-demo>
Reference in New Issue Copy Permalink