mdlp

mdlp

Markdown live preview from the command line! It can use a local command or the GitHub API.

It also renders mermaid diagrams in code blocks.

Installation

If you have Go installed, you can simply:

go install github.com/icub3d/mdlp@latest

You can also find the latest version on the releases page.

Integrating with Emacs

Here is how I do it using use-package and straight.el:

;; mdlp
(use-package mdlp-mode
  :ensure t
  :hook (markdown-mode . mdlp-mode)
  :straight (:host github :repo "icub3d/mdlp" :files ("mdlp-mode.el"))
  :config
  (setq mdlp-github-token "your-token-here"))

If you keep your token in a file, you can do something like:

;; f
(use-package f
  :ensure t
  :straight t)
  
;; mdlp
(use-package mdlp-mode
  :ensure t
  :hook (markdown-mode . mdlp-mode)
  :straight (:host github :repo "icub3d/mdlp" :files ("mdlp-mode.el"))
  :config
  (setq mdlp-github-token (string-trim (f-read-text "~/path/to/my/pat"))))

Both of these have the effect of starting up the process when you open up a file that starts markdown-mode. It is still very crude, pull requests are welcomed.

Examples For Testing

This section isn't really related to the project itself. I use it when testing the renderers.

A simple flowchart diagram in mermaid.

graph TD;
	A-->B;
	B-->D;
	C-->D;
	D-->F;
	F-->A;

A sequence diagram in mermaid.

sequenceDiagram
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
    Alice-)John: See you later!

Some Go Code!

package main

import "fmt"

func main() {
	fmt.Println("Hello, world!")
}

TODO

• github action to build it
• unit testing (? :))
• Handle multiple instances in emacs