MarkdownEditor
Features Usage Contribute

Java · Swing · Desktop

Write Markdown.
See it rendered, instantly.

A small, focused desktop editor for Markdown files — a raw pane on the left, a live preview on the right, and nothing else competing for your attention.

Get started View source Download
you typeyou get
## Weekly notes Track progress with a checklist: - [x] Draft outline - [ ] Add table | Task | Owner | |---|---| | Ship it | You |

Weekly notes

Track progress with a checklist:

  • ☑ Draft outline
  • ☐ Add table

Task / Owner table renders below it.

What it does

Built for writing, not managing settings. Every feature is one most Markdown files actually need.

Using it

Four steps from download to a finished document.

  1. Download the app

    Grab the latest Windows installer from the Releases page. It bundles a Java runtime, so a separate JDK is not required.

  2. Open a file or folder

    Use File → Open for a single document, or File → Open Folder to browse a whole project in the sidebar.

  3. Write

    Type Markdown on the left. The right pane updates as you go — no separate preview command to remember.

  4. Save or export

    Save back to .md with Ctrl+S, or turn the current preview into a PDF from the Export menu.

Contributing

The project is built in NetBeans with drag-and-drop Swing forms, so the fastest path in is opening it the same way.

  1. Clone the repo

    git clone https://github.com/aungthuhein2005/MarkdownEditor.git

  2. Open in NetBeans

    Use File → Open Project and select the cloned folder. The UI forms open in the Design view, controllers and models are plain Java.

  3. Make your change

    The app follows a light MVC split — model/, controller/, and ui/ — so most fixes touch one package at a time.

  4. Open a pull request

    Push a branch and describe what changed and why. Small, focused PRs are easiest to review.

Found a bug instead? Open an issue with your OS and Java version — the app includes both in the report template.