Git Product home page Git Product logo

adeeteya / fluttermarkdowneditor Goto Github PK

View Code? Open in Web Editor NEW
140.0 4.0 13.0 6.18 MB

Markdown Editor app allows easy markdown file creation and editing. It opens ".md" files directly from explorer, provides text styling options, effortless link addition, Light and Dark Theme Modes, Multiple View Modes. Developed using Flutter, it's mainly intended for mobile devices as there are no standalone markdown editors presently available.

License: MIT License

Kotlin 2.18% Swift 0.63% Objective-C 0.06% Dart 50.70% HTML 2.90% CMake 15.58% C++ 26.81% C 1.14%
android dart flutter flutter-apps flutter-examples markdown markdown-editor markdown-previewer mobile-app

fluttermarkdowneditor's Introduction

πŸ“ 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, 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 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

Get it on Google Play

(or)

Download apk

✨ Features

  • Ability to open .md files directly from the explorer
  • Convenient way to style text (bold,italics,headings and etc)
  • Convenient way to add links
  • Ability to preview JPEG, PNG, GIF, WebP, BMP, and WBMP image formats.
  • Easily open links from the preview
  • Light and Dark Theme Modes available
  • Dual View Mode available (Both Preview and Editing View)
  • Single View Mode available (Either Preview or the Editing View)
  • Added Multi Language Support (For Some of the most popular languages of the world)
  • Ability to clear text and start from scratch
  • Create new .md files
  • Edit existing .md files

πŸ“Έ Screenshots

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

πŸ”Œ Plugins

Name Usage
flutter_markdown To render markdown text
permission_handler To get storage permissions for opening and saving .md files
url_launcher To launch markdown links
file_picker To open markdown files directly from the app
expandable To create expandable header buttons
flutter_localizations Internationalizing app
intl Provides internationalization and localization facilities
flutter_lints For linting

πŸ€“ Author

Aditya R

πŸ”– LICENCE

Copyright (c) 2023 Aditya R MIT LICENCE

πŸ™ Attributions

Text Editor icons created by Freepik - Flaticon

fluttermarkdowneditor's People

Contributors

adeeteya avatar cccc-owo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

fluttermarkdowneditor's Issues

View and Edit at the Same Time

Currently, there is either edit mode or view mode. That's typical for how markdown editors and viewers work. How would we combine them in a hybrid edit mode?

In hybrid-edit mode, the entire document would be in view mode with the exception of the block or paragraph the cursor is onβ€”that would be in hybrid-edit mode.

Have a setting to configure for edit or hybrid-edit mode.

There would still be a view/edit button.

line break <br/> does not work

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

[Feature Request] Table maker in the toolbar

Edit: I just wanted to let you know that this app is amazing. You are very good developer. Thank you so much.

Is your feature request related to a problem? Please describe.
I use markdown tables a lot and would like to have that feature in this app.

Describe the solution you'd like
A built-in table maker that lets you choose how many rows and columns. I figured a button on the toolbar where the bold, italics, etc is would work well.

Describe alternatives you've considered
Manually make a table or use a different app.

Additional context

Table like this
Would be nice
Thanks for the amazing app

Language not adapted

Describe the bug
The app is neither in my language nor in english. My android phone is set in french but when I open the app:
ScreenshotMarkDownApp.jpg

To Reproduce
Steps to reproduce the behavior:

  1. Download the app from the playstore
  2. Open the app

Expected behavior
Get the same beautiful design but with text in my language or in english

Screenshots
See: "describe the bug".

Desktop (please complete the following information):
not tried on desktop

Smartphone (please complete the following information):

  • Device: [Samsung Galaxy A51]
  • OS: [Android 13]
  • Markdown Editor Version [1.1.0]

Additional context
This application seems amazing !

Cannot open files in the file manager

Describe the bug
I can only open markdown files inside the software. When I try to open the file in the file manager, the software tells me that I should try to open the file in the software.

To Reproduce
Steps to reproduce the behavior:

  1. Locate the markdown file
  2. Click on the file
  3. Select "Markdown Editor"
  4. See error

Expected behavior
The editor opens the file successfully

Screenshots
Screenshot_2023-09-12-14-42-05-636_android
Screenshot_2023-09-12-14-29-44-050_com adeeteya markdown_editor

Smartphone (please complete the following information):

  • Device: Xiaomi Redmi K50 Pro
  • OS: MIUI 14 (Android 13)
  • Browser: Lemur Browser, a Chrome-based browser for Android that supports extensions
  • Version: 1.2.0

Additional context
My file manager is Material Files and my ROM is MIUI 14 (Android 13). I don't know whether the problem is caused by this software, file manager or OS.

Check checkboxs

Is your feature request related to a problem? Please describe.
N/A

Describe the solution you'd like
Please add the ability to press on a checkbox in view mode to check the box

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
when making a list with checkboxs currently the only way to mark as complete (check the checkbox) is to edit the syntax (add and x inside the checkbox syntax).

[Feature Request] Internationalize strings

Is your feature request related to a problem? Please describe.
I think this app should have multi-language support.

Describe the solution you'd like
Make strings translatable.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
This app is more than useful. If possible, I'm willing to help with Chinese(Simplified) localisation.

Checkboxes barely visible in dark mode

Describe the bug
When in dark mode the check boxes are too dark and barely visible

To Reproduce
Steps to reproduce the behavior:
enable dark mode
add a check box

Expected behavior
check boxes should be easily visible

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: N/A
  • Browser N/A
  • Version N/A

Smartphone (please complete the following information):

  • Device: Pixel 6
  • OS: Android 14
  • Browser firefox
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

Customize save location

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Would love to be able to select a location to save files rather than having them default to the apps data directory when modifying an existing file or downloads when saving a new file

Describe the solution you'd like
A clear and concise description of what you want to happen.

Add a setting to set a default save location

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Only alternative I've come up with is to use tasker to move the file where I want it when closing the markdown editor

Additional context
Add any other context or screenshots about the feature request here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.