Skip to content
ttx89-devPublic

About

BuntuMD: simple Flutter markdown editor

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

BuntuMD: A Full-Fledged Markdown Editor for Ubuntu

BuntuMD is a versatile and customizable Markdown editor built with Flutter, specifically designed for .md and .markdown files on Ubuntu. It offers a seamless editing experience with live preview, extensive customization options, and integration with the Ubuntu system theme.

Features

  • Live Preview: Instantly see your Markdown rendered as you type.
  • File Operations: Open, edit, and save .md or .markdown files with ease.
  • Flexible View Modes: Toggle between split-view (editor and preview side-by-side), editor-only, and preview-only modes to suit your workflow.
  • Extensive Customization:
    • Adjust font size for both the editor and preview.
    • Customize editor background and text colors.
  • Ubuntu Theme Integration: Adapts automatically to your system's light or dark theme for a native look and feel.
  • Draggable Window: The application window can be easily moved around your desktop.

Installation and Usage

Building from Source

To build BuntuMD from source, ensure you have Flutter SDK installed and configured for Linux development.

  1. Clone the repository:
    git clone [YOUR_REPOSITORY_URL_HERE]
    cd buntumd
  2. Get Flutter dependencies:
    flutter pub get
  3. Build the Linux release version:
    flutter build linux --release
    The compiled application bundle will be located in build/linux/x64/release/bundle/.

Running the Application

After building, you can run BuntuMD directly from the compiled bundle:

  1. Navigate to the release bundle directory:
    cd build/linux/x64/release/bundle/
  2. Execute the application:
    ./buntumd
    The application window will appear, and you can start editing your Markdown files.

Screenshots

BuntuMD Screenshot

Contributing

We welcome contributions! If you find any bugs or have suggestions for new features, please feel free to open an issue or submit a pull request.

License

This project is licensed under the [Your License Here] - see the LICENSE.md file for details.

About

BuntuMD: simple Flutter markdown editor

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages