Skip to content

A simple, fast, general-purpose Markdown Editor Built Using TypeScript And Vanilla HTML.

Notifications You must be signed in to change notification settings

Crystal-Studio-Development/InkMD

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

InkMD Logo

InkMD

The Modern Markdown Editor for Creative Minds

Write. Preview. Create.
InkMD provides a seamless, distraction-free environment for your markdown needs.
Built for speed, designed for clarity, engineered for creators.

Version License Status Platform Authors

React TypeScript Vite Tailwind Lucide

VS Code Prettier ESLint Vercel

Uptime Build Size Repo Size Last Commit Website


Launch App




🌟 Overview

InkMD is a state-of-the-art Markdown editor running entirely in your browser. It combines the simplicity of a notepad with the power of a modern IDE. Whether you are documenting code, writing a blog post, or taking rapid notes, InkMD offers a sophisticated split-pane interface that renders your markdown in real-time.

Unlike traditional editors that require sign-ups or cloud storage, InkMD operates with a local-first philosophy. Your keystrokes never leave your browser unless you choose to share them. It is the perfect tool for developers, technical writers, and students who value speed, privacy, and aesthetics.

"The private, fast, and beautiful way to write markdown on the web."

InkMD Dashboard Preview

πŸš€ Why Choose InkMD?

πŸ”’ Maximum Privacy

Local-First Architecture. No account required. No cloud database. Your keystrokes never leave your browser memory unless you explicitly export them.

⚑ Blazing Performance

Powered by Vite & React 19. Experience sub-millisecond distinct rendering updates. Handles large documents (10k+ words) without stuttering.

🎨 Crafted Aesthetics

Designed for Focus. A native dark-mode interface with carefully selected typography and syntax highlighting colors to reduce eye strain.

πŸ› οΈ Developer Ready

Code First. First-class support for code blocks, syntax highlighting, and GitHub Flavored Markdown (GFM) right out of the box.


✨ Features & Capabilities

InkMD is engineered to be the last markdown editor you'll ever need.

✍️ Editor Core πŸ‘€ Live Preview πŸ“¦ Export & Data
πŸ”Ή Split-Pane View
Write and preview simultaneously in sync.
πŸ”Ή GFM Support
Tables, Task Lists, Strikethrough, and Auto-linking.
πŸ”Ή Instant Export
Download your work as .md files in one click.
πŸ”Ή Syntax Highlighting
Auto-detection code blocks via rehype-highlight.
πŸ”Ή Math Support
(Coming Soon) $LaTeX$ rendering for equations.
πŸ”Ή Copy to Clipboard
Formatted HTML or Raw Markdown copying.
πŸ”Ή History Stack
Robust Undo/Redo Engine (up to 50 states).
πŸ”Ή Safe HTML
Sanitized output to prevent XSS attacks while rendering.
πŸ”Ή Local Storage
(Coming Soon) Browser persistence so you never lose data.

🎨 Visual & UI Features

  • Distraction-Free Mode: The toolbar and unnecessary elements fade away when typing.
  • Responsive Toolbar: Quick access to Bold, Italic, Lists, Code, Links, and Quotes.
  • Auto-Closing Tags: Smart handling of brackets [] and parentheses ().

πŸ“± Mobile Friendly

Mobile View

Write Anywhere, Anytime

InkMD isn't just for desktops. We've optimized the experience for touch devices:

  • πŸ“± Responsive Design: UI adapts to phone and tablet screens.
  • πŸ‘† Touch Optimized: Buttons and toolbars are finger-friendly.
  • πŸ”„ View Toggling: Easily switch between Editor and Preview modes on small screens.

Supports All Modern Browsers

Chrome Firefox Edge Safari Opera Brave


πŸ—οΈ Technology Stack

We leverage a robust, modern stack to ensure InkMD is fast, reliable, and easy to maintain.

Core Architecture Markdown Engine Styling & Assets DevOps & Tools
React React Markdown Tailwind Vercel
TypeScript Remark Lucide Vite
Node.js Highlight PostCSS ESLint

πŸ—ΊοΈ Roadmap

We are constantly improving. Here is what we are working on for 2026:

  • v1.0 Launch: Core editor and live preview.
  • Cloud Sync: Optional Google Drive / GitHub Gist integration.
  • Themes: Light mode and custom color palettes.
  • Plugins: Support for Mermaid charts and mathematical notation (KaTeX).

❓ Frequently Asked Questions

πŸ’° Is InkMD free to use?
Yes! The hosted version at ink-md.vercel.app is completely free for everyone.
πŸ”“ Is the project open source?
The source code is currently proprietary. However, we are actively considering opening specific modules in the future once the core is stable.
πŸ› How can I report a bug?
Please use our GitHub Issues page or join our Discord Community.

🀝 Join the Community

Connect with other writers and developers.






❀️ Support Development

InkMD is developed with love and caffeine.






If you find InkMD useful, please consider giving it a star! ⭐️


⭐ Star History

Star History Chart


Β© 2026 Crystal Studio Development

Made with ❀️ And β˜• by Shuvranshu Sahoo

Terms of Service β€’ Privacy Policy β€’ Security

About

A simple, fast, general-purpose Markdown Editor Built Using TypeScript And Vanilla HTML.

Topics

Resources

Security policy

Stars

Watchers

Forks