Skip to content

matsuyoshi30/mo

 
 

Repository files navigation

mo

mo is a Markdown viewer that opens .md files in a browser.

Install

homebrew tap:

$ brew install k1LoW/tap/mo

manually:

Download binary from releases page

Usage

$ mo README.md                          # Open a single file
$ mo README.md CHANGELOG.md docs/*.md   # Open multiple files
$ mo spec.md --target design            # Open in a named group

mo opens Markdown files in a browser with live-reload. When you save a file, the browser automatically reflects the changes.

Single server, multiple files

By default, mo runs a single server process on port 6275. If a server is already running on the same port, subsequent mo invocations add files to the existing session instead of starting a new one.

$ mo README.md          # Starts a server and opens the browser
$ mo CHANGELOG.md       # Adds the file to the running server

To run a completely separate session, use a different port:

$ mo draft.md -p 6276

Multiple files with sidebar

Groups

Files can be organized into named groups using the --target (-t) flag. Each group gets its own URL path and sidebar.

$ mo spec.md --target design      # Opens at http://localhost:6275/design
$ mo api.md --target design       # Adds to the "design" group
$ mo notes.md --target notes      # Opens at http://localhost:6275/notes

Group view

Flags

Flag Short Default Description
--target -t default Group name
--port -p 6275 Server port

Build

Requires Go and pnpm.

$ make build

About

mo is a Markdown viewer that opens .md files in a browser.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 54.2%
  • Go 30.0%
  • CSS 13.7%
  • Makefile 1.5%
  • HTML 0.6%