Atlas

Open-Source Markdown Editor, Math & Document Exporter

Atlas is an ultra-lightweight, high-fidelity Markdown editor and document preparation workspace built for writers, researchers, developers, and educators. It combines real-time synchronized editing with mathematical typesetting, diagramming, presentation slides, and enterprise-grade PDF/Word exports.

Launch Live Workspace · Report Bug · Request Feature · Production Checklist

---

Highlights

• Live Synchronized Split-Pane: Sub-millisecond synchronized dual-scroll markdown editor and preview with draggable split panes.
• Linear-Style Command Palette (Cmd+K / Ctrl+K): Rapidly switch files, trigger exports, toggle view layouts, and format text without leaving your keyboard.
• Mathematical & Chemical Typesetting: First-class KaTeX support for inline ($...$) and block ($$...$$) math, plus chemical equations ($\ce{...}$).
• Interactive Mermaid.js Diagrams: Real-time rendering of flowcharts, sequence diagrams, state machines, and Gantt charts.
• Vector & Raster PDF Export Desk:
  • Built-in cover page generator (Minimalist, Modern Stripe, Editorial, and Academic).
  • Customizable diagonal watermarks and automated page numbering headers/footers.
• Multi-Format Document Exporter: One-click download as Microsoft Word (.docx), styled standalone HTML, print-ready PDF, or raw Markdown.
• Presentation Mode (Slides): Instantly turn your markdown into interactive slide decks with horizontal rules (---) and modern presentation themes.
• Local-First & Zero Lock-In: Automatic offline-ready persistence in your browser with simple import/export capabilities.

---

Architecture & Technology Stack

graph TD
    A[Next.js 15 App Router] --> B[Marketing & Showcase /]
    A --> C[Workspace App /app]
    
    C --> D[CodeMirror Editor]
    C --> E[React-Markdown Engine]
    C --> F[Command Palette Cmd+K]
    C --> G[Document Storage Hook]
    
    E --> H[KaTeX & Math]
    E --> I[Mermaid.js Diagrams]
    
    C --> J[Export Generators]
    J --> K[Vector/Raster PDF]
    J --> L[Word .docx Packer]
    J --> M[Standalone HTML]

Loading

• Framework: Next.js (App Router, Server Components & Dynamic Code-Splitting)
• UI Components: Radix UI & Lucide Icons
• Styling: Tailwind CSS v4 with custom Linear-style CSS design tokens
• Editor Engine: @uiw/react-codemirror
• Document Engines: docx, jsPDF, html2canvas-pro, mermaid, rehype-katex
• Testing: Vitest

---

Keyboard Shortcuts

Shortcut	Action
Cmd / Ctrl + K	Open Command Palette
Cmd / Ctrl + B	Bold Text
Cmd / Ctrl + I	Italic Text
Cmd / Ctrl + E	Inline Code
Cmd / Ctrl + P	Toggle Presentation Mode
Cmd / Ctrl + S	Quick Save Document

---

Getting Started & Local Development

Prerequisites

• Node.js (v20.x or later)
• pnpm (v9.x or later)

Quick Start

# 1. Clone the repository
git clone https://github.com/crine-in/atlas.git
cd atlas

# 2. Install dependencies
pnpm install

# 3. Start local development server
pnpm dev

Open http://localhost:3000 to view the landing page, or http://localhost:3000/app for the workspace editor.

---

Quality & Verification Scripts

Run the following checks before committing code:

pnpm lint        # Run ESLint validation
pnpm typecheck   # Validate TypeScript types
pnpm test        # Run Vitest unit tests
pnpm format      # Format code with Prettier
pnpm build       # Validate production Next.js build

---

Contributing

We welcome community contributions! Please review our Contributing Guidelines and our Code of Conduct.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

Support & Contact

Maintained by CRINE.

• Support Email: support@crine.in
• Live Application: https://atlas.crine.in
• Organization Website: https://www.crine.in

---

License

Atlas is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for the full text.

---

_{Built by CRINE for the Open-Source community.}