plainship

README

Ship your Git-native content as durable static websites.

English | 中文

What is Plainship

Plainship is a local-first, Git-first publishing system for Markdown content.

• Content lives in a Git repository as plain Markdown; Git owns history, diffs, and collaboration.
• One command incrementally builds a static website, commits the result, and assigns a build number.
• One command publishes the site to your own server; the server only stores, syncs, and serves static HTTP.
• Two small static binaries — plainship and plainship-server — are released together with the same version.

Quick start

On the server

One command installs plainship-server, starts the service, and prints the server URL and access token.

Linux / macOS

# Install and start the server, then print the URL and access token
curl -fsSL https://raw.githubusercontent.com/emanyzwww/plainship/master/scripts/install.sh | bash

Windows (PowerShell)

# Download the installer
Invoke-WebRequest -UseBasicParsing https://raw.githubusercontent.com/emanyzwww/plainship/master/scripts/install.ps1 -OutFile install.ps1
# Install and start the server
.\install.ps1

On your computer

Install the latest client:

# Install the client
go install github.com/emanyzwww/plainship/cmd/plainship@latest

Create a new project and publish your first document:

# Create a new project (initializes Git)
plainship new mydoc
cd mydoc

# Create a document
plainship create "my-first-doc"
# Build: commit and assign a build number
plainship build -m "first document"

# Connect to your server (paste the token when prompted)
plainship connect http://<server>:9090

# Publish to the server
plainship publish

The generated build/ directory is a self-contained static site that can be deployed to any static host.

For local development with hot reload:

# Local preview with hot reload
plainship dev

Documentation

• Usage guide — CLI reference, configuration, front matter, directory layout, languages, and rollback.
• Build & publishing — build, commit, and numbering workflow, releases, and design principles.
• Build, commit & revision — build mechanism, machine commit protocol, and base paths.
• Server & sync protocol — server deployment, installation, and the sync API.
• Architecture & development — module structure, dependency direction, and development workflow.
• Output & UX architecture — the internal/ui event-stream design (implemented, v2).

Development

Plainship requires Go 1.26+.

Build the binaries:

# Build the client
go build -o plainship ./cmd/plainship
# Build the server
go build -o plainship-server ./cmd/plainship-server

Run the test suite:

# Run all tests
go test ./...

Design principles

Plainship is built around a few simple principles:

• Git-first — Git remains the source of truth for content, history, and collaboration.
• Local-first — authoring and building happen locally, without requiring a hosted CMS.
• Static by default — the published site is static and can be served by almost any HTTP server.
• Simple deployment — the server is intentionally small and only handles storage, synchronization, and serving.
• Durable content — Markdown files and Git history remain usable without Plainship.

License

MIT