中文

Your self-hosted notion alternative

This repository only contains part of the full product family.

Inside this repo:

• apps/siyuan: the free edition authoring frontend, implemented as a Siyuan plugin.
• apps/app: the unified viewer application used by different deployment targets.

Outside this repo:

• share-pro: the paid/professional authoring frontend.
• siyuan-note-service: the paid/professional backend service.

So there are two different product flows:

• Free path: apps/siyuan -> host Siyuan kernel / local public files -> apps/app viewer
• Pro path: share-pro -> siyuan-note-service -> apps/app viewer

The important distinction is:

• The free authoring frontend talks directly to the host Siyuan instance.
• It does not use an application backend owned by this repo during authoring.
• The backend only exists in the separate pro product line.

flowchart LR
    subgraph Free["Free Distribution Path"]
        A["apps/siyuan<br/>Free Authoring Frontend<br/>(Siyuan Plugin)"]
        B["Host Siyuan Kernel<br/>+ Local Public Files"]
        V["apps/app<br/>Unified Viewer"]
        A --> B --> V
    end

    subgraph Pro["Pro Distribution Path"]
        P["share-pro<br/>Pro Authoring Frontend"]
        S["siyuan-note-service<br/>Pro Backend"]
        V2["apps/app<br/>Unified Viewer"]
        P --> S --> V2
    end

# run apps/app from the monorepo root
pnpm dev

# cp ./startup.example.sh ./startup.sh
# change NUXT_PUBLIC_PROVIDER_URL or use default
./startup.sh

pnpm buildNodeProvider
pnpm packageNodeProvider

• Build command: pnpm build -F @terwer/share-pro-app -- --from siyuan
• Output type: free SPA viewer
• The generated viewer is distributed under /plugins/siyuan-blog/app/

• These are server-capable viewer targets

# default: start apps/app from the monorepo root
pnpm dev

# explicit alias
pnpm dev:app

# start the Siyuan plugin watcher from the monorepo root
pnpm dev:siyuan

# run every workspace dev task through turbo
pnpm dev:all

Click here