Markforge

---

📦 Installation

🌟 Option 1: Download Flatpak Bundle (Recommended)

Click to download and install Markforge:

After downloading, install with:

flatpak install --user Markforge.flatpak
flatpak run io.gitlab.Sanjai_Shaarugesh.Markforge

🔨 Option 2: Build from Source

Prerequisites

• Python 3.10+
• GTK 4.10+
• Libadwaita 1.4+
• Just (build tool)

Install Dependencies

Fedora/RHEL:

sudo dnf install python3 gtk4 libadwaita gtksourceview5 just \
                 python3-markdown python3-pygments

Ubuntu/Debian:

sudo apt install python3 libgtk-4-dev libadwaita-1-dev \
                 libgtksourceview-5-dev just python3-markdown \
                 python3-pygments

Arch Linux:

sudo pacman -S python gtk4 libadwaita gtksourceview5 just \
               python-markdown python-pygments

Quick Build

git clone https://gitlab.com/Sanjai-Shaarugesh/Markforge.git
cd Markforge
just flatpak-install

Or run directly:

just run

---

💖 Support the Project

Your support helps keep Markforge growing and improving!

Other Ways to Support

⭐	Star the repository
🐛	Report bugs and suggest features
🔀	Contribute code or documentation
📢	Spread the word about Markforge!

Thank you for your support!

---

📸 Screenshots

---

✨ Features

🚀 Core Functionality

• Live Markdown Preview - Real-time formatted view
• Synchronized Scrolling - Editor & preview in sync
• GPU-Accelerated - Smooth, fast performance
• File History - Built-in version tracking
• Auto-Save - Never lose your work

📝 Markdown Support

• Extended Syntax - Tables, task lists, strikethrough
• Mermaid Diagrams - Flowcharts, sequence diagrams
• LaTeX Math - Beautiful equations & formulas
• GitHub Alerts - Note, Tip, Warning blocks
• Syntax Highlighting - Language-specific code blocks

🎨 User Interface

• Adaptive Design - Desktop to mobile
• Dark Mode - Eye-friendly themes
• Distraction-Free Mode - Focus on writing
• Rich Toolbar - Quick formatting access
• File Manager - Organize documents easily

🔧 Productivity Tools

• Search & Replace - With regex support
• Export Options - HTML, PDF, and more
• Template Support - Quick-start templates
• Keyboard Shortcuts - Efficient editing
• Multi-format Support - Import/export flexibility

---

🎯 GitHub Alerts Support

Markforge supports all GitHub-style alert types for better documentation!

[!NOTE] Useful information that users should know, even when skimming content.

[!TIP] Helpful advice for doing things better or more easily.

[!IMPORTANT] Key information users need to know to achieve their goal.

[!WARNING] Urgent info that needs immediate user attention to avoid problems.

[!CAUTION] Advises about risks or negative outcomes of certain actions.

---

🚀 Quick Start

1. Create Document → Click + or press Ctrl+N
2. Start Writing → Type in Markdown on the left
3. Live Preview → See formatted output on the right
4. Save Work → Press Ctrl+S (auto-save enabled)
5. Export → File → Export to HTML, PDF, etc.

---

⌨️ Keyboard Shortcuts

File Operations

Action	Shortcut
New Document	Ctrl + N
Open File	Ctrl + O
Save	Ctrl + S
Save As	Ctrl + Shift + S
Export	Ctrl + E

Editing

Action	Shortcut
Find	Ctrl + F
Replace	Ctrl + H
Bold	Ctrl + B
Italic	Ctrl + I
Toggle Preview	Ctrl + P

View Options

Action	Shortcut
Distraction-Free Mode	F11
Preferences	Ctrl + ,

---

🎯 Use Cases

Use Case	Features Used
📚 Technical Documentation	Mermaid diagrams, syntax highlighting, tables
📝 Note Taking	Quick formatting, file organization, auto-save
✍️ Blog Writing	Live preview, export options, templates
🎓 Academic Writing	LaTeX math, citations, professional formatting
💻 README Files	GitHub alerts, code blocks, markdown preview
📋 Project Planning	Mermaid flowcharts, task lists, diagrams

---

🤝 Contributing

Markforge is community-built! We welcome all contributions.

How to Contribute

# Fork and clone
git clone https://github.com/YOUR_USERNAME/Markforge.git
cd Markforge

# Create feature branch
git checkout -b feature/amazing-feature

# Make changes and commit
git commit -m 'Add amazing feature'

# Push and create merge request
git push origin feature/amazing-feature

Areas We Need Help

• 🐛 Bug Fixes - Testing and debugging
• 🌍 Translations - See po/README.md
• 📖 Documentation - Guides and tutorials
• ✨ Features - New capabilities
• 🎨 UI/UX - Design improvements
• 🔍 Code Reviews - Quality assurance

---

🐛 Reporting Issues

Found a bug or have a feature request?

1. Check existing issues
2. Click "New Issue"
3. Choose appropriate template
4. Provide detailed information
5. Submit!

---

📖 Documentation

• 📘 User Guide
• ⌨️ Keyboard Shortcuts
• 📝 Markdown Syntax
• 🤝 Contributing Guide
• 📋 Code of Conduct

---

🌍 Translations

Markforge supports multiple languages! Want to add yours?

Check our translation guide to get started.

---

🗺️ Roadmap

Near Future

• Plugin system for extensions
• Cloud sync support
• Custom themes
• Collaborative editing

Long Term

• PDF annotation
• Voice dictation
• Git integration

---

🙏 Acknowledgments

Built with amazing open-source technologies:

• GTK 4 & Libadwaita - UI Framework
• Markdown - Markdown rendering
• Mermaid - Diagrams
• MathJax - Math rendering

---

📞 Contact

Developer: Sanjai Shaarugesh

📧 Email: [email protected]
🦊 GitHub: @Sanjai-Shaarugesh
💬 Discussions: Join here

---

📄 License

This project is licensed under GNU General Public License v3.0 or later.

See LICENSE for details.

---