# Opal Editor

## Docs

- [Image Optimization](https://mintlify.wiki/rbbydotdev/opal/advanced/image-optimization.md): Automatic WebP conversion, caching, and optimization strategies
- [Service Workers](https://mintlify.wiki/rbbydotdev/opal/advanced/service-workers.md): Offline-first architecture with service worker request handling
- [Storage Architecture](https://mintlify.wiki/rbbydotdev/opal/advanced/storage.md): Local-first data persistence with IndexedDB and OPFS
- [Template Engines](https://mintlify.wiki/rbbydotdev/opal/advanced/templates.md): Dynamic HTML generation with Eta, Liquid, Mustache, and Nunjucks
- [Architecture Overview](https://mintlify.wiki/rbbydotdev/opal/development/architecture.md): Understand Opal Editor's local-first architecture, core systems, and how components interact
- [Build System](https://mintlify.wiki/rbbydotdev/opal/development/build-system.md): Pluggable static site generation with Freeform and Eleventy-style build strategies
- [Contributing to Opal Editor](https://mintlify.wiki/rbbydotdev/opal/development/contributing.md): Learn how to contribute to Opal Editor, including development setup, code style, and pull request guidelines.
- [Git System](https://mintlify.wiki/rbbydotdev/opal/development/git-system.md): Isomorphic Git integration for browser-based version control with zero backend dependencies
- [Development Setup](https://mintlify.wiki/rbbydotdev/opal/development/setup.md): Get started contributing to Opal Editor with local development environment setup and testing
- [Storage System](https://mintlify.wiki/rbbydotdev/opal/development/storage-system.md): Pluggable disk abstraction layer supporting IndexedDB, OPFS, and in-memory storage backends
- [Testing Guide](https://mintlify.wiki/rbbydotdev/opal/development/testing.md): Learn how to write and run tests for Opal Editor, including unit tests with TestSuite and E2E tests with Playwright.
- [Workspace System](https://mintlify.wiki/rbbydotdev/opal/development/workspace-system.md): Core workspace architecture for managing local-first markdown projects with Git integration
- [Editing](https://mintlify.wiki/rbbydotdev/opal/features/editing.md): Write and edit markdown with a rich-text editor and source code view
- [Git Integration](https://mintlify.wiki/rbbydotdev/opal/features/git-integration.md): Version control with built-in git support and GitHub synchronization
- [Publishing](https://mintlify.wiki/rbbydotdev/opal/features/publishing.md): Deploy your static sites to Netlify, Vercel, Cloudflare Pages, GitHub Pages, or S3
- [Templates](https://mintlify.wiki/rbbydotdev/opal/features/templates.md): Transform markdown into HTML using EJS, Mustache, Nunjucks, or Liquid templates
- [Workspaces](https://mintlify.wiki/rbbydotdev/opal/features/workspaces.md): Organize your content in isolated workspaces with flexible storage options
- [Introduction to Opal Editor](https://mintlify.wiki/rbbydotdev/opal/introduction.md): A local-first markdown editor and static publisher with complete self-custody, Git integration, and zero backend dependencies
- [Deploy to Cloudflare Pages](https://mintlify.wiki/rbbydotdev/opal/publishing/cloudflare-pages.md): Publish your Opal Editor sites to Cloudflare's global network with Pages for fast, secure hosting
- [Deploy to GitHub Pages](https://mintlify.wiki/rbbydotdev/opal/publishing/github-pages.md): Deploy your Opal Editor sites to GitHub Pages using Git-based deployment with automatic hosting
- [Deploy to Netlify](https://mintlify.wiki/rbbydotdev/opal/publishing/netlify.md): Publish your Opal Editor sites to Netlify with automatic CDN, SSL, and continuous deployment
- [Publishing Overview](https://mintlify.wiki/rbbydotdev/opal/publishing/overview.md): Learn how to publish your Opal Editor sites to various hosting platforms with zero backend dependencies
- [Deploy to AWS S3](https://mintlify.wiki/rbbydotdev/opal/publishing/s3.md): Publish your Opal Editor sites to Amazon S3 static website hosting with full control over infrastructure
- [Deploy to Vercel](https://mintlify.wiki/rbbydotdev/opal/publishing/vercel.md): Deploy your Opal Editor sites to Vercel's global edge network with instant deployments and automatic SSL
- [Quickstart](https://mintlify.wiki/rbbydotdev/opal/quickstart.md): Get started with Opal Editor in minutes - create your first workspace, write markdown, and preview your content