Skip to content

jayyvarmaa/formd

Repository files navigation

ForMD

ForMD Logo

The Future of Markdown Rendering

A professional, monochromatic, skeomorphic Markdown editor and preview suite.

License Version Platform

Live DemoDesktop PortDocumentation


🚀 Overview

ForMD is a premium, client-side Markdown suite designed for professionals who demand a high-fidelity, GitHub-style writing experience. Built on a sophisticated monochromatic skeomorphic design system, ForMD provides a tactile, immersive environment for creating technical documentation, blog posts, and diagrams.


✨ Key Features

✒️ Professional Editor

  • Live Sync-Scrolling: Keep your editor and preview panes perfectly aligned.
  • Skeomorphic UI: A deep, monochromatic interface (#050505 to #fbfbfb) designed for focus.
  • Real-time Statistics: Track word count, character count, and reading time instantly.

📊 Advanced Rendering

  • GitHub-Fidelity: Renders Markdown exactly as it appears on GitHub.
  • Mermaid Diagrams: Integrated zoom, pan, and export (PNG/SVG) tools via a dedicated toolbar.
  • LaTeX Math Support: Professional mathematical typesetting for technical papers.

🔌 Interoperability

  • Multi-Format Export: Save as high-quality PDF, standalone HTML, or standard Markdown.
  • GitHub Sync: Import files directly from public GitHub repositories.
  • Privacy-First: 100% client-side processing. Your data never leaves your browser.

🎨 Design Philosophy: Skeomorphism 2.0

ForMD departs from the flat-design trend, embracing a minimalist monochromatic skeomorphic aesthetic. By utilizing subtle inner and outer shadows, we've created a UI that feels tactile and weighted, reducing cognitive load while providing a premium, "desktop-software" feel even in the browser.


📦 Deployment & Usage

🌐 Web (Recommended)

Simply visit formd.jayvarma.site to start writing. No installation or account required.

🖥️ Native Desktop

ForMD is available as a native cross-platform application built with Neutralinojs.

  • Location: See the formd-desktop/ directory.
  • Build: Run npm run setup && npm run dev inside the folder to launch.

🐳 Docker Deployment

Deploy your own instance using our high-performance Nginx-based Docker image:

docker run -p 8080:80 -d ghcr.io/jayyvarmaa/formd:latest

🛠️ Built With


🤝 Contributing & Heritage

We welcome contributions to help refine ForMD further. Please feel free to submit a Pull Request.

  • Source Heritage: This project is a fork of the Markdown Viewer project.
  • License: This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Developed by jayyvarmaa