Sitepins Documentation
Welcome to the documentation for Sitepins, an open-source, Git-based headless CMS designed for static site generators including Astro, Hugo, Next.js, Nuxt, SvelteKit, TanStack Start, Eleventy, and Jekyll.
Sitepins is Git-native. Your repository remains the single source of truth. Every edit in Sitepins becomes a standard Git commit in your repository — no proprietary databases, no vendor lock-in.
Why Sitepins?
Traditional CMSs force you to choose between developer flexibility and non-technical authoring convenience. Sitepins bridges the gap:
- Git-Native Workflow: Every edit is an ordinary Git commit in your own repository. Your existing CI/CD pipelines (Vercel, Netlify, Cloudflare, GitHub Actions) trigger builds automatically.
- Visual & Markdown Editing: Switch seamlessly between a block-based rich text editor and raw Markdown without losing cursor position or formatting.
- Works with Any SSG: Supports Astro, Next.js, Hugo, Nuxt, SvelteKit, and more — reading Markdown, MDX, JSON, YAML, and TOML.
- Live Preview: Run your real dev server in a sandboxed container to preview uncommitted changes live as you type.
- Real-Time Collaboration: Real-time presence, multi-user cursors, and conflict-safe commit handling.
- Flexible Data Schemas: Use optional JSON schemas to define form fields, validations, and relational dropdowns, or let Sitepins automatically infer forms from your frontmatter.
- AI Assistant: Bring your own API key (OpenAI, Anthropic, Google, xAI) to generate, summarize, or edit content inline.
- Fully Self-Hostable: Run Sitepins on your own infrastructure with Docker, MongoDB, and S3 storage with 100% unlocked features.
Documentation Sections
Explore the documentation guides below:
🚀 Getting Started
Learn how to create an account, connect your first GitHub or GitLab repository, configure content folders, or launch a project from prebuilt templates.
- What is Sitepins
- Create an Account
- Add a New Site
- Configure Your Site
- Start from a Template
- Interface Tour
- Global Search
📁 Content Structure
Understand how Sitepins maps repository files, directories, and data models to editing views.
✍️ Visual & Code Editing
Master the editor with rich text, raw Markdown, code editing, live preview, and AI capabilities.
- Rich Text Editor
- Markdown Mode
- Code Editor
- Live Preview
- Saving & Publishing
- AI Assistant
- Blocks & Embeds
- Snippets
- Version History
- SEO Tools
👥 Collaboration
Work together seamlessly with permissions, branches, and real-time editing.
🏢 Organizations & Sandboxes
Manage organizations, multiple projects, and preview sandboxes.
⚙️ Project Settings
Configure repository connections, branch policies, and deployment webhooks.
👤 Account & Billing
Manage user profiles, authentication, security, and subscription plans.
🖥️ Self-Hosting
Complete reference for deploying and operating the open-source Sitepins core on your own servers.