docs: update content

This commit is contained in:
Philipp Kühn
2021-04-08 22:17:52 +02:00
parent bd392ee8c2
commit cbbb6bf4e1
3 changed files with 10 additions and 4 deletions

View File

@@ -19,6 +19,11 @@ import CodeBlockComponent from './CodeBlockComponent'
// install all highlight.js languages
import 'lowlight'
// or install specific languages only
// import lowlight from 'lowlight/lib/core'
// import javascript from 'highlight.js/lib/languages/javascript'
// lowlight.registerLanguage('javascript', javascript)
export default {
components: {
EditorContent,

View File

@@ -18,6 +18,11 @@ import CodeBlockLowlight from '@tiptap/extension-code-block-lowlight'
// install all highlight.js languages
import 'lowlight'
// or install specific languages only
// import lowlight from 'lowlight/lib/core'
// import javascript from 'highlight.js/lib/languages/javascript'
// lowlight.registerLanguage('javascript', javascript)
export default {
components: {
EditorContent,

View File

@@ -6,10 +6,6 @@ With the CodeBlock extension you can add fenced code blocks to your documents. I
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.
::: warning Restrictions
The CodeBlock extension doesnt come with styling and has no syntax highlighting built-in. Its on our roadmap though.
:::
## Installation
```bash
# with npm