melw

Melw - Markdown Editor Like WikiEngine

( English / Japanese )

Melw is a small, local web application for editing Markdown files with a WikiEngine-like user interface.

• Runs a web server on localhost.
• Directly edits Markdown files on the local filesystem.
• Uses a plain textarea for editing.
• Requires no JavaScript. Uses HTMX
• Uses no database or proprietary file format.

Install

Manual Installation

Download the binary package from Releases and extract the executable.

Use eget installer (cross-platform)

brew install eget        # Unix-like systems
# or
scoop install eget       # Windows

cd (YOUR-BIN-DIRECTORY)
eget hymkor/melw

Use scoop-installer (Windows only)

scoop install https://raw.githubusercontent.com/hymkor/melw/master/melw.json

or

scoop bucket add hymkor https://github.com/hymkor/scoop-bucket
scoop install melw

Use "go install" (requires Go toolchain)

go install github.com/hymkor/melw@latest

Note: go install places the executable in $HOME/go/bin or $GOPATH/bin, so you need to add this directory to your $PATH to run melw.

Usage

1. Start the melw executable in a directory containing Markdown files.
2. Open http://127.0.0.1:8000 in your browser.
3. A list of files in the directory where melw was started will be displayed.
   • Clicking a link to a directory navigates to that directory.
   • Clicking a link to a Markdown file displays its contents rendered as HTML.
   • Clicking a link to a non-Markdown file displays its contents as-is.
4. On a Markdown file page, click the Edit button to edit the source of the page.
   • Click Preview to preview the edited source rendered as HTML.
     The preview is updated almost in real time while editing.
   • Click Save to save the edited source to the file and finish editing.
   • Click Cancel to cancel editing and discard the changes.

Options

• -C string
  Change working directory
• -P uint
  Port number (default 8000)
• -start
  Open web browser at startup