Skip to content

ManWithA1000Names/Mark

Repository files navigation

⚠️ WORK IN PROGRESS ⚠️

Mark

Fast, easy, simple, cross-platform markdown viewing.

Features:

  • 🛩️ Small
  • ⚡ Performant
  • 📡 Live updates
  • ⌨️ Keyboard Driven
  • 📑 Multiple Files
  • ⬇️ Markdown files only file picker
  • 🐙 Full CommonMark + GitHub Flavored Markdown (GFM) support.

Open files from the terminal

    mark ./file1.md ./file2.md ...

Keyboard Bindings

shortcut action
H | SHIFT + ← Previous File
L | SHIFT + → Next File
h | Scroll Page Left
l | Scroll Page Right
k | Scroll Page Up
j | Scroll Page Down
f Open File Picker
c Close File
o + Link ID Open Link
q Exit the Application
e Edit the file
? View Shortcuts

Maybe Additional Features

  • Add support for [[./some/path]] based routing.
  • Add option to open file in github.com if it originates from there.

TODO

Front-end

  • Implement keyboard shortcuts.

  • Error Handling

  • Notification System

  • Shortcut Guide

  • Multi-file widget thing

  • CSS refactor

  • Option to "stick to bottom"

  • Option to switch to the file that changed.

  • Remove tailwindcss but keep postcss

  • Make it obvious when there are no files to search.

  • Set default font.

  • Rewrite in elm? => yes.

  • Rewrite styles in tailwindcss => yes.

  • Allow for light/dark theme switching.

Back-end

  • Implement remove-file
  • Flush out client-backend interface // invokes & listeners
  • Error Handling
  • Refactor & Optimize
  • Test behavior when the watcher fails.
  • fork the markdown rust crate and optimize it for this specific use case.

Both

  • Links seem to be broken
  • Links starting with "/..." should be prepended with github.com or something.
  • Open with default applicaiton seems to be broken.

About

Mark - fast,simple,small makrdown viewer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published