@open-cloud-initiative/editor-x 0.0.1

package/.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.238.1/containers/ubuntu/.devcontainer/base.Dockerfile
+
+# [Choice] Ubuntu version (use ubuntu-24.04 or ubuntu-18.04 on local arm64/Apple Silicon): ubuntu-24.04, ubuntu-20.04, ubuntu-18.04
+ARG VARIANT="jammy"
+FROM mcr.microsoft.com/vscode/devcontainers/base:1-${VARIANT}
+
+# Install additional OS packages, if needed.
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends ca-certificates
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install protobuf-compiler

package/.devcontainer/devcontainer.json

@@ -0,0 +1,52 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    // Update 'VARIANT' to pick an Ubuntu version: jammy / ubuntu-22.04, focal / ubuntu-20.04, bionic /ubuntu-18.04
+    // Use ubuntu-24.04 or ubuntu-18.04 on local arm64/Apple Silicon.
+    "args": {
+      "VARIANT": "ubuntu-24.04"
+    }
+  },
+  "postStartCommand": "git config --global --add safe.directory ${containerWorkspaceFolder}",
+  "postCreateCommand": "bash scripts/postCreateCommand.sh",
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/node:1": {},
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/devcontainers/features/git-lfs:1": {}
+  },
+  "containerEnv": {
+    "SHELL": "/usr/bin/zsh"
+  },
+  "appPort": 3000,
+  "forwardPorts": [
+    3000,
+    5432
+  ],
+  "portsAttributes": {
+    "3000": {
+      "label": "Application",
+      "onAutoForward": "notify"
+    },
+    "5432": {
+      "label": "PostgreSQL",
+      "onAutoForward": "notify"
+    }
+  },
+  "hostRequirements": {
+    "cpus": 8,
+    "memory": "16gb",
+    "storage": "32gb"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-ossdata.vscode-pgsql",
+        "dbaeumer.vscode-eslint",
+        "GitHub.copilot",
+        "GitHub.copilot-chat",
+        "eamodio.gitlens"
+      ]
+    }
+  }
+}

package/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

package/.github/workflows/pages.yml

@@ -0,0 +1,42 @@
+name: Pages
+
+on:
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+      - run: npm ci
+      - run: npm run build
+        env:
+          BASE_PATH: /editor-x
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    publish-npm:
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: write
+            contents: read
+        steps:
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
+              with:
+                  node-version: 24
+                  registry-url: 'https://registry.npmjs.org'
+                  cache: npm
+            - run: npm ci
+            - run: npm version ${TAG_NAME} --git-tag-version=false
+              env:
+                  TAG_NAME: ${{ github.event.release.tag_name }}
+            - run: npm --ignore-scripts publish --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - uses: actions/upload-pages-artifact@v4
+              with:
+                  path: ./examples
+    publish-page:
+        runs-on: ubuntu-latest
+        needs: publish-npm
+        permissions:
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - id: deployment
+              uses: actions/deploy-pages@v4

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "source.organizeImports": "explicit",
+    "source.sortMembers": "explicit"
+  }
+}

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2026 Sebastian Doell (@katallaxie)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# Editor X
+
+![Editor X](images/editor.png "Editor X")
+
+An advanced editor built on [shadcn/ui](https://ui.shadcn.com/) und [Tiptap](https://tiptap.dev/).
+
+## License
+
+[MIT](/LICENSE)

package/app/_component/editor.tsx

@@ -0,0 +1,383 @@
+'use client'
+
+import type { Editor, JSONContent } from '@/components/editorx/editor'
+import {
+    EditorBubbleMenu,
+    EditorCharacterCount,
+    EditorClearFormatting,
+    EditorFormatBold,
+    EditorFormatCode,
+    EditorFormatItalic,
+    EditorFormatStrike,
+    EditorFormatSubscript,
+    EditorFormatSuperscript,
+    EditorFormatUnderline,
+    EditorLinkSelector,
+    EditorNodeBulletList,
+    EditorNodeCode,
+    EditorNodeHeading1,
+    EditorNodeHeading2,
+    EditorNodeHeading3,
+    EditorNodeOrderedList,
+    EditorNodeQuote,
+    EditorNodeTaskList,
+    EditorNodeText,
+    EditorProvider,
+    EditorSelector,
+    EditorTableColumnAfter,
+    EditorTableColumnBefore,
+    EditorTableColumnDelete,
+    EditorTableColumnMenu,
+    EditorTableDelete,
+    EditorTableFix,
+    EditorTableGlobalMenu,
+    EditorTableHeaderColumnToggle,
+    EditorTableHeaderRowToggle,
+    EditorTableMenu,
+    EditorTableMergeCells,
+    EditorTableRowAfter,
+    EditorTableRowBefore,
+    EditorTableRowDelete,
+    EditorTableRowMenu,
+    EditorTableSplitCell,
+} from '@/components/editorx/editor'
+import { EditorToolbar } from '@/components/editorx/toolbars/editor-toolbar'
+import Highlight from '@tiptap/extension-highlight'
+import { useState } from 'react'
+
+export default function ExampleEditor() {
+    const [content, setContent] = useState<JSONContent>({
+        type: 'doc',
+        content: [
+            {
+                type: 'heading',
+                attrs: { level: 1 },
+                content: [{ type: 'text', text: 'Heading 1' }],
+            },
+            {
+                type: 'heading',
+                attrs: { level: 2 },
+                content: [{ type: 'text', text: 'Heading 2' }],
+            },
+            {
+                type: 'heading',
+                attrs: { level: 3 },
+                content: [{ type: 'text', text: 'Heading 3' }],
+            },
+            {
+                type: 'heading',
+                attrs: { level: 4 },
+                content: [{ type: 'text', text: 'Heading 4' }],
+            },
+            {
+                type: 'heading',
+                attrs: { level: 5 },
+                content: [{ type: 'text', text: 'Heading 5' }],
+            },
+            {
+                type: 'heading',
+                attrs: { level: 6 },
+                content: [{ type: 'text', text: 'Heading 6' }],
+            },
+            { type: 'paragraph' },
+            { type: 'paragraph', content: [{ type: 'text', text: 'Hello, world.' }] },
+            { type: 'paragraph' },
+            {
+                type: 'taskList',
+                content: [
+                    {
+                        type: 'taskItem',
+                        attrs: { checked: false },
+                        content: [
+                            {
+                                type: 'paragraph',
+                                content: [{ type: 'text', text: 'This is a todo list' }],
+                            },
+                        ],
+                    },
+                    {
+                        type: 'taskItem',
+                        attrs: { checked: false },
+                        content: [
+                            {
+                                type: 'paragraph',
+                                content: [{ type: 'text', text: 'With two items' }],
+                            },
+                        ],
+                    },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'bulletList',
+                content: [
+                    {
+                        type: 'listItem',
+                        content: [
+                            {
+                                type: 'paragraph',
+                                content: [{ type: 'text', text: 'This is an unordered list' }],
+                            },
+                            {
+                                type: 'bulletList',
+                                content: [
+                                    {
+                                        type: 'listItem',
+                                        content: [
+                                            {
+                                                type: 'paragraph',
+                                                content: [{ type: 'text', text: 'With a nested item' }],
+                                            },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'orderedList',
+                attrs: { start: 1 },
+                content: [
+                    {
+                        type: 'listItem',
+                        content: [
+                            {
+                                type: 'paragraph',
+                                content: [{ type: 'text', text: 'This is an ordered list' }],
+                            },
+                        ],
+                    },
+                    {
+                        type: 'listItem',
+                        content: [
+                            {
+                                type: 'paragraph',
+                                content: [{ type: 'text', text: 'With two items' }],
+                            },
+                        ],
+                    },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'blockquote',
+                content: [
+                    {
+                        type: 'paragraph',
+                        content: [
+                            {
+                                type: 'text',
+                                text: 'This is a quote, probably by someone famous.',
+                            },
+                        ],
+                    },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'paragraph',
+                content: [
+                    { type: 'text', text: 'This is some ' },
+                    { type: 'text', marks: [{ type: 'code' }], text: 'inline code' },
+                    { type: 'text', text: ', while this is a code block:' },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'codeBlock',
+                attrs: { language: null },
+                content: [
+                    {
+                        type: 'text',
+                        text: "function x () {\\n  console.log('hello, world.');\\n}",
+                    },
+                ],
+            },
+            { type: 'paragraph' },
+            {
+                type: 'paragraph',
+                content: [
+                    {
+                        type: 'text',
+                        text: 'You can also create complex tables, like so:',
+                    },
+                ],
+            },
+            {
+                type: 'table',
+                content: [
+                    {
+                        type: 'tableRow',
+                        content: [
+                            {
+                                type: 'tableHeader',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Here’s a column' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableHeader',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Another column' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableHeader',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Yet another' }],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        type: 'tableRow',
+                        content: [
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 1A' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 2A' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 3A' }],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        type: 'tableRow',
+                        content: [
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 1B' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 2B' }],
+                                    },
+                                ],
+                            },
+                            {
+                                type: 'tableCell',
+                                attrs: { colspan: 1, rowspan: 1, colwidth: null },
+                                content: [
+                                    {
+                                        type: 'paragraph',
+                                        content: [{ type: 'text', text: 'Cell 3B' }],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            },
+        ],
+    })
+    const handleUpdate = ({ editor }: { editor: Editor }) => {
+        const json = editor.getJSON()
+        setContent(json)
+        console.log(JSON.stringify(json))
+    }
+
+    return (
+        <EditorProvider
+            className="h-full w-full overflow-y-auto rounded-lg border bg-background p-4"
+            content={content}
+            onUpdate={handleUpdate}
+            placeholder="Start typing..."
+            extensions={[Highlight]}
+            slotBefore={<EditorToolbar />}
+        >
+            <EditorBubbleMenu>
+                <EditorSelector title="Text">
+                    <EditorNodeText />
+                    <EditorNodeHeading1 />
+                    <EditorNodeHeading2 />
+                    <EditorNodeHeading3 />
+                    <EditorNodeBulletList />
+                    <EditorNodeOrderedList />
+                    <EditorNodeTaskList />
+                    <EditorNodeQuote />
+                    <EditorNodeCode />
+                </EditorSelector>
+                <EditorSelector title="Format">
+                    <EditorFormatBold />
+                    <EditorFormatItalic />
+                    <EditorFormatUnderline />
+                    <EditorFormatStrike />
+                    <EditorFormatCode />
+                    <EditorFormatSuperscript />
+                    <EditorFormatSubscript />
+                </EditorSelector>
+                <EditorLinkSelector />
+                <EditorClearFormatting />
+            </EditorBubbleMenu>
+            <EditorTableMenu>
+                <EditorTableColumnMenu>
+                    <EditorTableColumnBefore />
+                    <EditorTableColumnAfter />
+                    <EditorTableColumnDelete />
+                </EditorTableColumnMenu>
+                <EditorTableRowMenu>
+                    <EditorTableRowBefore />
+                    <EditorTableRowAfter />
+                    <EditorTableRowDelete />
+                </EditorTableRowMenu>
+                <EditorTableGlobalMenu>
+                    <EditorTableHeaderColumnToggle />
+                    <EditorTableHeaderRowToggle />
+                    <EditorTableDelete />
+                    <EditorTableMergeCells />
+                    <EditorTableSplitCell />
+                    <EditorTableFix />
+                </EditorTableGlobalMenu>
+            </EditorTableMenu>
+            <EditorCharacterCount.Words>Words: </EditorCharacterCount.Words>
+        </EditorProvider>
+    )
+}

package/app/layout.tsx

@@ -0,0 +1,46 @@
+import { siteConfig } from '@/config/site'
+import { PREFERENCE_DEFAULTS } from '@/lib/preferences-config'
+import { ThemeBootScript } from '@/scripts/theme-boot'
+import { PreferencesStoreProvider } from '@/stores/preferences/preferences-provider'
+import '@/styles/globals.css'
+import { SiteFooter } from 'components/site-footer'
+import { SiteHeader } from 'components/site-header'
+import type { Metadata } from 'next'
+import { Inter } from 'next/font/google'
+
+const inter = Inter({ subsets: ['latin'] })
+
+export const metadata: Metadata = {
+    title: 'Editor X - Build Your Rich Text Editor',
+    keywords: [],
+    authors: [
+        {
+            name: siteConfig.author,
+        },
+    ],
+    creator: siteConfig.author,
+}
+
+export default function RootLayout({
+    children,
+}: Readonly<{
+    children: React.ReactNode
+}>) {
+    const { theme_mode, theme_preset } = PREFERENCE_DEFAULTS
+
+    return (
+        <html lang="en" className={theme_mode} data-theme-preset={theme_preset} suppressHydrationWarning>
+            <head>
+                {/* Applies theme and layout preferences on load to avoid flicker and unnecessary server rerenders. */}
+                <ThemeBootScript />
+            </head>
+            <body className={`${inter.className} min-h-screen antialiased`}>
+                <PreferencesStoreProvider themeMode={theme_mode} themePreset={theme_preset}>
+                    <SiteHeader />
+                    {children}
+                    <SiteFooter />
+                </PreferencesStoreProvider>
+            </body>
+        </html>
+    )
+}

package/app/page.tsx

@@ -0,0 +1,11 @@
+import ExampleEditor from '@/app/_component/editor'
+
+export default function Home() {
+    return (
+        <main className="flex min-h-screen flex-col w-full items-center ">
+            <section id="basic-editor" className="w-full container py-12 scroll-mt-10">
+                <ExampleEditor />
+            </section>
+        </main>
+    )
+}

package/app/r/registry.json/route.ts

@@ -0,0 +1,22 @@
+import { getPackage } from '@/lib/package'
+import { type NextRequest, NextResponse } from 'next/server'
+import type { Registry } from 'shadcn/schema'
+
+export const dynamic = 'force-static'
+
+export const GET = async (_: NextRequest) => {
+    const response: Registry = {
+        name: 'Editor X',
+        homepage: 'https://open-cloud-initiative.github.io/editor-x',
+        items: [],
+    }
+
+    try {
+        const pkg = await getPackage('editor-x')
+        response.items.push(pkg)
+    } catch (err) {
+        // skip packages that fail
+    }
+
+    return NextResponse.json(response)
+}