Skip to content

README.md

Latest commit

 

History

History
143 lines (94 loc) · 3.84 KB

README.md

File metadata and controls

143 lines (94 loc) · 3.84 KB

write0

write0

License: MIT Architecture: Static

write0 is a distraction-free markdown writing environment designed for the modern web — a 100% client-side application (no backend, no databases, no API routes).

Inspired by minimalist writing tools like iA Writer, with a fully client-side, open-source implementation.

✨ Features

🧘 Distraction-Free Environment

The interface is designed to disappear when you start writing. The sidebar and toolbar gently fade away after 1.5 seconds of typing, leaving nothing but you and your thoughts. They reappear instantly the moment you move your mouse.

🎯 Focus Mode

Keep your attention where it belongs. Focus Mode dims all paragraphs except the one you are currently editing, helping you maintain "flow" and preventing your eyes from wandering.

🔍 Real-time Style Check

Improve your writing as you go. write0 automatically highlights:

  • Blue: Adverbs (e.g., "truly", "quickly", "softly")
  • Purple: Weak verbs (e.g., "was", "is", "have", "get") This visual feedback helps you craft stronger, more active prose.

📄 Live Markdown Preview

Toggle a split-screen preview to see your markdown rendered in real-time. Whether you're writing technical docs or a novel, the preview ensures your formatting is always on point.

📥 Universal Export

Take your work anywhere. Export your documents with a single click as:

  • Markdown (.md): Standard format for cross-platform compatibility.
  • HTML: Web-ready content.
  • PDF: Print-optimized documents with a clean, professional layout.

🖼️ Screenshots

Editor + sidebar

Focus Mode

🛠️ Architecture: Web Native

write0 is a 100% client-side app:

  • Vite + React: Local development with fast HMR and a static production build.
  • Tailwind CDN: Styling via the Tailwind runtime (no Tailwind build step).
  • LocalStorage: Documents and settings are stored locally in your browser (no accounts, no server storage).
  • Exports: HTML/Markdown export downloads a file; “PDF” uses the browser print dialog.

🚀 Getting Started

You can test it out here.

Local Development (Vite)

Install dependencies, then start the dev server:

npm install
npm run dev

Quality Checks

npm run typecheck
npm run lint
npm run format:check

Production Build

npm run build
npm run preview

📂 Project Structure

/
├── index.html       # Entry point
├── App.tsx          # Main application logic
├── components/      # Modular UI components
├── utils/           # Export and Markdown logic
├── constants.ts     # Style check regex and defaults
└── types.ts         # TypeScript definitions

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for setup and guidelines.

🙏 Inspiration

This project is inspired by minimalist writing tools like iA Writer — especially the focus on minimalism, clarity, and staying out of the way while you write.

📜 License

Distributed under the MIT License. See LICENSE for more information.

Built with ❤️ for writers everywhere.