diff --git a/docs/src/demos/Extensions/CodeBlock/index.spec.js b/docs/src/demos/Extensions/CodeBlock/index.spec.js new file mode 100644 index 00000000..7e16e15f --- /dev/null +++ b/docs/src/demos/Extensions/CodeBlock/index.spec.js @@ -0,0 +1,5 @@ +context('/api/extensions/code-block', () => { + beforeEach(() => { + cy.visit('/api/extensions/code-block') + }) +}) \ No newline at end of file diff --git a/docs/src/demos/Extensions/CodeBlock/index.vue b/docs/src/demos/Extensions/CodeBlock/index.vue new file mode 100644 index 00000000..e5277407 --- /dev/null +++ b/docs/src/demos/Extensions/CodeBlock/index.vue @@ -0,0 +1,51 @@ + + + \ No newline at end of file diff --git a/docs/src/demos/Guide/BuildYourEditor/index.vue b/docs/src/demos/Guide/BuildYourEditor/index.vue index 7aafa12d..c1800d82 100644 --- a/docs/src/demos/Guide/BuildYourEditor/index.vue +++ b/docs/src/demos/Guide/BuildYourEditor/index.vue @@ -37,7 +37,7 @@ import History from '@tiptap/extension-history' import Bold from '@tiptap/extension-bold' import Italic from '@tiptap/extension-italic' import Code from '@tiptap/extension-code' -import CodeBlock from '@tiptap/extension-codeblock' +import CodeBlock from '@tiptap/extension-code-block' import Heading from '@tiptap/extension-heading' export default { diff --git a/docs/src/docPages/api/extensions/code-block.md b/docs/src/docPages/api/extensions/code-block.md index 11e44289..95224d7b 100644 --- a/docs/src/docPages/api/extensions/code-block.md +++ b/docs/src/docPages/api/extensions/code-block.md @@ -2,10 +2,20 @@ Enables you to use the `
` HTML tag in the editor.
 
 ## Options
-*None*
+| Option | Type   | Default | Description                                  |
+| ------ | ------ | ------- | -------------------------------------------- |
+| class  | string | –       | Add a custom class to the rendered HTML tag. |
 
 ## Commands
-*None*
+| Command   | Options | Description                   |
+| --------- | ------- | ----------------------------- |
+| codeBlock | —       | Wrap content in a code block. |
 
 ## Keyboard shortcuts
-*None*
\ No newline at end of file
+* `Shift` + `Control` + `\`
+
+## Source Code
+[packages/extension-code-block/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/)
+
+## Usage
+
diff --git a/packages/extension-codeblock/index.ts b/packages/extension-code-block/index.ts
similarity index 100%
rename from packages/extension-codeblock/index.ts
rename to packages/extension-code-block/index.ts
diff --git a/packages/extension-code-block/package.json b/packages/extension-code-block/package.json
new file mode 100644
index 00000000..a2ee3a26
--- /dev/null
+++ b/packages/extension-code-block/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "@tiptap/extension-code-block",
+  "version": "1.0.0",
+  "source": "index.ts",
+  "main": "dist/tiptap-extension-code-block.js",
+  "umd:main": "dist/tiptap-extension-code-block.umd.js",
+  "module": "dist/tiptap-extension-code-block.mjs",
+  "unpkg": "dist/tiptap-extension-code-block.js",
+  "jsdelivr": "dist/tiptap-extension-code-block.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "peerDependencies": {
+    "@tiptap/core": "2.x"
+  }
+}
diff --git a/packages/extension-codeblock/package.json b/packages/extension-codeblock/package.json
deleted file mode 100644
index 05f4ce9f..00000000
--- a/packages/extension-codeblock/package.json
+++ /dev/null
@@ -1,17 +0,0 @@
-{
-  "name": "@tiptap/extension-codeblock",
-  "version": "1.0.0",
-  "source": "index.ts",
-  "main": "dist/tiptap-extension-codeblock.js",
-  "umd:main": "dist/tiptap-extension-codeblock.umd.js",
-  "module": "dist/tiptap-extension-codeblock.mjs", 
-  "unpkg": "dist/tiptap-extension-codeblock.js",
-  "jsdelivr": "dist/tiptap-extension-codeblock.js",
-  "files": [
-    "src",
-    "dist"
-  ],
-  "peerDependencies": {
-    "@tiptap/core": "2.x"
-  }
-}
diff --git a/packages/starter-kit/index.ts b/packages/starter-kit/index.ts
index e052487d..487207c7 100644
--- a/packages/starter-kit/index.ts
+++ b/packages/starter-kit/index.ts
@@ -5,7 +5,7 @@ import History from '@tiptap/extension-history'
 import Bold from '@tiptap/extension-bold'
 import Italic from '@tiptap/extension-italic'
 import Code from '@tiptap/extension-code'
-import CodeBlock from '@tiptap/extension-codeblock'
+import CodeBlock from '@tiptap/extension-code-block'
 import Heading from '@tiptap/extension-heading'
 import HardBreak from '@tiptap/extension-hard-break'
 import Strike from '@tiptap/extension-strike'
diff --git a/packages/starter-kit/package.json b/packages/starter-kit/package.json
index 712700bd..d93e5a76 100644
--- a/packages/starter-kit/package.json
+++ b/packages/starter-kit/package.json
@@ -19,7 +19,7 @@
     "@tiptap/extension-bold": "1.x",
     "@tiptap/extension-italic": "1.x",
     "@tiptap/extension-code": "1.x",
-    "@tiptap/extension-codeblock": "1.x",
+    "@tiptap/extension-code-block": "1.x",
     "@tiptap/extension-heading": "1.x"
   }
 }
diff --git a/packages/vue-starter-kit/index.ts b/packages/vue-starter-kit/index.ts
index 25255d7d..0c9dda1f 100644
--- a/packages/vue-starter-kit/index.ts
+++ b/packages/vue-starter-kit/index.ts
@@ -7,7 +7,7 @@ import History from '@tiptap/extension-history'
 import Bold from '@tiptap/extension-bold'
 import Italic from '@tiptap/extension-italic'
 import Code from '@tiptap/extension-code'
-import CodeBlock from '@tiptap/extension-codeblock'
+import CodeBlock from '@tiptap/extension-code-block'
 import Heading from '@tiptap/extension-heading'
 import HardBreak from '@tiptap/extension-hard-break'
 import Strike from '@tiptap/extension-strike'
diff --git a/packages/vue-starter-kit/package.json b/packages/vue-starter-kit/package.json
index 9edbaab4..a927ac50 100644
--- a/packages/vue-starter-kit/package.json
+++ b/packages/vue-starter-kit/package.json
@@ -20,7 +20,7 @@
     "@tiptap/extension-bold": "1.x",
     "@tiptap/extension-italic": "1.x",
     "@tiptap/extension-code": "1.x",
-    "@tiptap/extension-codeblock": "1.x",
+    "@tiptap/extension-code-block": "1.x",
     "@tiptap/extension-heading": "1.x"
   }
 }