adeeteya/FlutterMarkdownEditor

📝 Flutter Markdown Editor

Introducing the Markdown Editor app, the perfect tool for anyone who needs to create and edit markdown files with ease. With the ability to open ".md" files directly from the explorer, you can easily access your files and start working on them right away.

The app also offers a convenient way to style your text with options such as bold, italics, headings, and more. Adding links is also a breeze with the simple interface.

In addition, you can preview JPEG, PNG, GIF, WebP, BMP, and WBMP image formats right within the app. You can easily open links from the preview, making it easy to navigate between different files and sources.

Choose between Light and Dark Theme Modes, use Dynamic Color for improved theme customization, and use the Dual View Mode to simultaneously view both the preview and editing views. Alternatively, you can use Single View Mode to focus on either the preview or editing view.

The app also offers the ability to share your markdown files as plain text, markdown, or PDF, clear text and start from scratch, as well as create new .md files or edit existing ones.

This Editor was developed using Flutter and is mainly targeted for mobile devices as currently there aren't any standalone markdown editors available.

Please star⭐ the repo if you like what you see😊.

💻 Installation links

Platform	Installation Links
Android	Get it on Google Play Get it on F-Droid APK download
Linux	Download .AppImage Download .deb Download .rpm Get it from the Snap Store
Windows	Download Windows Installer
Web App	Web App

✨ Features

• [x] Ability to open .md files directly from the explorer
• [x] Convenient way to style text (bold,italics,headings and etc)
• [x] Convenient way to add links
• [x] Convenient way to add tables
• [x] Ability to preview JPEG, PNG, GIF, WebP, BMP, and WBMP image formats.
• [x] Easily open links from the preview
• [x] Light and Dark Theme Modes available
• [x] Dynamic Color support for improved theme customization
• [x] Dual View Mode available (Both Preview and Editing View)
• [x] Single View Mode available (Either Preview or the Editing View)
• [x] Added Multi Language Support (For Some of the most popular languages of the world)
• [x] Ability to clear text and start from scratch
• [x] Create new .md files
• [x] Edit existing .md files
• [x] LaTex support
• [x] Horizontal Swipe to Switch between Preview and Editing View in Single View Mode
• [x] Default Folder for Opening and Saving .md files
• [x] Added Print/Save as Pdf Option
• [x] Added Share as Plain Text, Markdown, and PDF Option
• [x] Added the option to check/uncheck checkboxes in preview mode

🌐 How to contribute to this project's translations

1. Fork this repository and create a branch dedicated to the translation you want to work on.
2. The source strings live in lib/l10n/app_en.arb. Copy it to lib/l10n/app_.arb (use the ISO language or language_region code) when adding a new language, or open the existing file if the language is already present.
3. Translate only the string values. Keep placeholders (such as {count}) and the accompanying @metadata blocks untouched so Flutter can still generate code correctly.
4. Run flutter gen-l10n from the project root to regenerate lib/l10n/generated/app_localizations.dart and to update untranslated_messages.json.
5. Launch the app (or run flutter test if you add tests) to double-check that your strings render correctly, then open a pull request describing the language(s) you updated.

📸 Screenshots

Light Mode Image Dark Mode Image File Explorer Image Add Link Image Markdown Preview Image Markdown Editor Image

🔌 Plugins

Name	Usage
dynamic_color	For improved theme customization
expandable	To create expandable header buttons
file_picker	To open markdown files directly from the app
flutter_localizations	Internationalizing app
flutter_math_fork	Help with LaTeX support
flutter_svg	To Display Svg Images
flutter_widget_from_html_core	To add html display support
google_fonts	To add custom fonts support
html	To help display html format
htmltopdfwidgets	To convert html to pdf for printing
intl	Provides internationalization and localization facilities
markdown	To convert markdown to html format
markdown_widget	To help display markdown/custom markdown
pdf	To help save/create a pdf
permission_handler	To get storage permissions for opening and saving .md files
printing	To help printing a pdf
share_plus	To share markdown files in various formats
shared_preferences	To store device preferences for persistence
url_launcher	To launch markdown links
flutter_lints	For linting

🤓 Author

Aditya R

🔖 LICENCE

Copyright (c) 2023 Aditya R MIT LICENCE

🙏 Attributions

Text Editor icons created by Freepik - Flaticon