ShipAny Docs

Getting Started

Run the template locally and ship your first page in five minutes

Prerequisites

  • Node.js 20+
  • pnpm 9+

Setup

Get the template

Get the template from shipany.ai/templates/shipany-docs, then clone your repository and install dependencies:

git clone <your-repo-url> my-product-docs
cd my-product-docs
pnpm install
Start the dev server
pnpm dev

Open http://localhost:3000 — the site renders the pages in content/docs/. English lives at /, Chinese at /zh.

Make it yours

Set your brand in .env (see Customization):

VITE_APP_NAME=My Product Docs
VITE_APP_LOGO=https://cdn.example.com/logo.png
VITE_SITE_URL=https://example.com
Write your first page

Create content/docs/hello.mdx:

---
title: Hello
description: My first docs page
---

Welcome to my product documentation!

Add its Chinese twin hello.zh.mdx, then list "hello" in content/docs/meta.json. The sidebar updates on save.

Project structure

content/docs/         # your documentation (MDX) — this is where you work
src/styles/theme.css  # color palette (shadcn variable format)
src/lib/config.ts     # env-driven branding
.env                  # VITE_APP_NAME, VITE_APP_LOGO, ...

Everything else (routing, search, i18n, layout) works without modification.

Commands

CommandDescription
pnpm devDev server on port 3000
pnpm buildProduction build
pnpm startServe the built output
pnpm cf:deployBuild and deploy to Cloudflare Workers

Next steps

Introduction

ShipAny Docs — a bilingual documentation site template for your product

Writing Content

Pages, frontmatter, sidebar order, links, and MDX components

On this page

Prerequisites
Setup
Project structure
Commands
Next steps