Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: PR Validation [auto]
name: CI SuperDoc

permissions:
contents: read
Expand All @@ -8,10 +8,11 @@ on:
branches: [main, 'release/**']
paths-ignore:
- 'apps/docs/**'
- 'packages/template-builder/**'
- '**/*.md'

concurrency:
group: pr-${{ github.event.pull_request.number }}
group: ci-superdoc-${{ github.event.pull_request.number }}
cancel-in-progress: true

jobs:
Expand All @@ -23,7 +24,7 @@ jobs:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}

- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # Pinned commit hash for @v4
- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
Expand All @@ -44,22 +45,22 @@ jobs:

- name: Install dependencies
run: pnpm install

- name: Validate commits
run: |
BASE=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})
pnpx commitlint \
--from "$BASE" \
--to ${{ github.event.pull_request.head.sha }}

run-unit-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}

- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # Pinned commit hash for @v4
- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
Expand Down Expand Up @@ -104,7 +105,7 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.sha }}

- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # Pinned commit hash for @v4
- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
Expand All @@ -129,7 +130,7 @@ jobs:
- name: Build SuperDoc
run: |
pnpm run build

- name: Install Playwright browsers
run: |
cd e2e-tests
Expand All @@ -138,7 +139,7 @@ jobs:
- name: Run e2e tests
id: run-e2e-tests
if: always()
run: cd e2e-tests && pnpm test
run: cd e2e-tests && pnpm test

- name: Upload e2e test results
id: upload_artifact
Expand All @@ -156,7 +157,7 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.sha }}

- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # Pinned commit hash for @v4
- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
Expand Down
45 changes: 45 additions & 0 deletions .github/workflows/ci-template-builder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: CI Template Builder

permissions:
contents: read

on:
pull_request:
paths:
- 'packages/template-builder/**'
workflow_dispatch:

concurrency:
group: ci-template-builder-${{ github.event.pull_request.number }}
cancel-in-progress: true

jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: pnpm

- name: Install dependencies
run: pnpm install

- name: Build superdoc (dependency)
run: pnpm run build:superdoc

- name: Lint
run: pnpm --filter @superdoc-dev/template-builder lint

- name: Type check
run: pnpm --filter @superdoc-dev/template-builder type-check

- name: Build
run: pnpm --filter @superdoc-dev/template-builder build

- name: Test
run: pnpm --filter @superdoc-dev/template-builder test
36 changes: 36 additions & 0 deletions .github/workflows/deploy-demos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Deploy Demos

on:
push:
branches: [main]
Comment on lines +1 to +5

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add write permissions for GitHub Pages deploy

This workflow uses peaceiris/actions-gh-pages@v4 to push to the gh-pages branch, but there is no permissions block granting contents: write. If the repo/org default for GITHUB_TOKEN is read‑only (a common security setting), the deploy step will fail with a 403 when it tries to push. Consider adding permissions: { contents: write } at the workflow or job level (and pages: write if you later switch to the Pages API flow).

Useful? React with 👍 / 👎.

paths:
- 'packages/template-builder/**'
# Add more demo paths here as needed
workflow_dispatch:

jobs:
deploy-template-builder-demo:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: pnpm
- run: pnpm install
- name: Build template-builder
run: pnpm --filter @superdoc-dev/template-builder build
- name: Build demo
run: pnpm --filter superdoc-template-builder-demo build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./packages/template-builder/demo/dist
cname: template-builder.superdoc.dev

# Add more demo deploy jobs here as needed
# deploy-another-demo:
# runs-on: ubuntu-latest
# steps: ...
10 changes: 9 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,22 @@ jobs:
- name: Build packages
run: pnpm run build

- name: Release
- name: Release superdoc
env:
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
LINEAR_TOKEN: ${{ secrets.LINEAR_TOKEN }}
run: pnpx semantic-release

- name: Release template-builder
env:
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
working-directory: packages/template-builder
run: pnpx semantic-release

# Sync stable back to main after stable release
# - name: Sync stable to main
# if: github.ref == 'refs/heads/stable'
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/ai/ai-builder/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ See the [AI Actions Quick Start](/ai/ai-actions/overview#quick-start) to get sta

## Get notified

Want to be notified when AI Builder launches? [Join our Discord](https://discord.com/invite/b9UuaZRyaB) or [watch on GitHub](https://github.com/Harbour-Enterprises/SuperDoc).
Want to be notified when AI Builder launches? [Join our Discord](https://discord.com/invite/b9UuaZRyaB) or [watch on GitHub](https://github.com/superdoc-dev/superdoc).
2 changes: 1 addition & 1 deletion apps/docs/api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ Your Word documents work because we built for Word documents. Not markdown. Not
## Resources

**[Status Page](https://status.superdoc.dev)** - Uptime and incidents
**[GitHub](https://github.com/Harbour-Enterprises/SuperDoc)** - Examples and issues
**[GitHub](https://github.com/superdoc-dev/superdoc)** - Examples and issues
2 changes: 1 addition & 1 deletion apps/docs/core/supereditor/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Convert DOCX files server-side without a browser using JSDOM.

<Info>
See the [headless-converter
example](https://github.com/Harbour-Enterprises/superdoc/tree/main/examples/advanced/headless-converter)
example](https://github.com/superdoc-dev/superdoc/tree/main/examples/advanced/headless-converter)
for a complete implementation.
</Info>

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@
"links": [
{
"type": "button",
"href": "https://github.com/Harbour-Enterprises/SuperDoc",
"href": "https://github.com/superdoc-dev/superdoc",
"label": "",
"icon": "github"
},
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/getting-started/ai-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const editor = new Editor({

editor.commands.insertContent(aiContent, { contentType: 'html' });
```
[See complete example →](https://github.com/Harbour-Enterprises/SuperDoc/tree/develop/examples/agentic-slack-redlining-example)
[See complete example →](https://github.com/superdoc-dev/superdoc/tree/develop/examples/agentic-slack-redlining-example)

## The AI Document Workflow

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/getting-started/frameworks/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,4 @@ function useSuperDoc(config) {

- [Vue Integration](/getting-started/frameworks/vue) - Vue setup
- [API Reference](/core/superdoc/configuration) - Configuration options
- [Examples](https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/react-example) - Working examples
- [Examples](https://github.com/superdoc-dev/superdoc/tree/main/examples/react-example) - Working examples
2 changes: 1 addition & 1 deletion apps/docs/getting-started/frameworks/vue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,4 @@ defineExpose({

- [React Integration](/getting-started/frameworks/react) - React setup
- [API Reference](/core/superdoc/configuration) - Configuration options
- [Examples](https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/vue-example) - Working examples
- [Examples](https://github.com/superdoc-dev/superdoc/tree/main/examples/vue-example) - Working examples
2 changes: 1 addition & 1 deletion apps/docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Get started with SuperDoc in minutes
<Card
title="Examples"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples"
>
Working demos and templates
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/guides/migration/prosemirror.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ If you need features SuperDoc doesn't provide, you have limited options:

## Need help?

- [GitHub Issues](https://github.com/Harbour-Enterprises/SuperDoc/issues)
- [GitHub Issues](https://github.com/superdoc-dev/superdoc/issues)
- [Discord Community](https://discord.com/invite/b9UuaZRyaB)
- Email: q@superdoc.dev
2 changes: 1 addition & 1 deletion apps/docs/modules/collaboration/cloud/liveblocks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ useEffect(() => {
<Card
title="Working Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/liveblocks"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/liveblocks"
>
Complete source code
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/modules/collaboration/cloud/tiptap-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ superdoc.destroy();
<Card
title="Working Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/tiptap-cloud"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/tiptap-cloud"
>
Complete source code
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/modules/collaboration/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ const client = createClient({
<Card
title="Working Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/liveblocks"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/liveblocks"
>
Complete source code on GitHub
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/modules/collaboration/self-hosted/hocuspocus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ Server.configure({
<Card
title="Working Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/hocuspocus"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/hocuspocus"
>
Complete source code
</Card>
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/modules/collaboration/self-hosted/superdoc-yjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -353,15 +353,15 @@ fastify.get('/health', (request, reply) => {
<Card
title="Production Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/production"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/production"
>
Complete working example
</Card>

<Card
title="Fastify Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/fastify-server"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/fastify-server"
>
Fastify server setup
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/modules/collaboration/self-hosted/y-sweet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ For production, consider:
<Card
title="Working Example"
icon="github"
href="https://github.com/Harbour-Enterprises/SuperDoc/tree/main/examples/collaboration/y-sweet"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/collaboration/y-sweet"
>
Complete source code
</Card>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "SuperDoc API",
"version": "0.9.0",
"description": "## Quick Start\n\n1 - **Register**: https://api.superdoc.dev/v1/auth/register?email=you@email.com\n\n2 - **Verify**: Check email, then https://api.superdoc.dev/v1/auth/verify?email=you@email.com&code=123456\n\n3 - **Convert**\n```bash\ncurl -X POST https://api.superdoc.dev/v1/convert?from=docx \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -F \"file=@document.docx\" \\\n -o converted.pdf\n```\n\n\nOr use our Playground:\nhttps://api.superdoc.dev/docs/#tag/documents/post/v1/convert\n\nThat's it! Your DOCX is now a PDF.\n\n---\n\n[Status](https://status.superdoc.dev) • [GitHub](https://github.com/Harbour-Enterprises/SuperDoc)",
"description": "## Quick Start\n\n1 - **Register**: https://api.superdoc.dev/v1/auth/register?email=you@email.com\n\n2 - **Verify**: Check email, then https://api.superdoc.dev/v1/auth/verify?email=you@email.com&code=123456\n\n3 - **Convert**\n```bash\ncurl -X POST https://api.superdoc.dev/v1/convert?from=docx \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -F \"file=@document.docx\" \\\n -o converted.pdf\n```\n\n\nOr use our Playground:\nhttps://api.superdoc.dev/docs/#tag/documents/post/v1/convert\n\nThat's it! Your DOCX is now a PDF.\n\n---\n\n[Status](https://status.superdoc.dev) • [GitHub](https://github.com/superdoc-dev/superdoc)",
"contact": {
"name": "Support",
"email": "api@superdoc.dev",
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/resources/license.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ For questions about licensing, please contact [q@superdoc.dev](mailto:q@superdoc

We welcome contributions from the community! Here's how you can help:

1. Check our [issue tracker](https://github.com/Harbour-Enterprises/SuperDoc/issues) for open issues
1. Check our [issue tracker](https://github.com/superdoc-dev/superdoc/issues) for open issues
2. Fork the repository and create a feature/bugfix branch
3. Write clear, documented code following our style guidelines
4. Submit a PR with detailed description of your changes

See our [Contributing Guide](https://github.com/Harbour-Enterprises/SuperDoc/blob/main/CONTRIBUTING.md) for more details.
See our [Contributing Guide](https://github.com/superdoc-dev/superdoc/blob/main/CONTRIBUTING.md) for more details.
2 changes: 1 addition & 1 deletion apps/docs/scripts/sync-api-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const https = require('https');
function fetchOpenAPI() {
return new Promise((resolve, reject) => {
https
.get('https://raw.githubusercontent.com/Harbour-Enterprises/SuperDoc-API/main/openapi.yaml', (res) => {
.get('https://raw.githubusercontent.com/superdoc-dev/superdoc-api/main/openapi.yaml', (res) => {
let data = '';
res.on('data', (chunk) => (data += chunk));
res.on('end', () => resolve(data));
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/snippets/components/source-code-link.jsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export const SourceCodeLink = ({ extension, path }) => {
// Default to standard extension path if no custom path provided
const githubPath = path || `packages/super-editor/src/extensions/${extension.toLowerCase()}`;
const githubUrl = `https://github.com/Harbour-Enterprises/SuperDoc/tree/main/${githubPath}`;
const githubUrl = `https://github.com/superdoc-dev/superdoc/tree/main/${githubPath}`;

return (
<div>
Expand Down
4 changes: 4 additions & 0 deletions packages/template-builder/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist/
node_modules/
*.log
.DS_Store
Loading
Loading