command
module
Version:
v0.0.0-...-054bb05
Opens a new window with list of versions in this module.
Published: Feb 27, 2023
License: MIT
Opens a new window with license information.
Imports: 18
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
Markdown Previewer
This does two things:
- Monitor a markdown file using fsnotify, convert it to HTML on save using goldmark and bluemonday (to sanitize the HTML), and display/update the display in a web browser at http://localhost:5052/content; or
- Convert a markdown file to an HTML file using the above tools.
Usage
Monitor an HTML file and display it in a web browser
❯ ./mdp -infile README.md
Server listening on http://localhost:5052/content
After this, the preview should open in a new browser tab and auto-update each time the file is saved.
Convert a markdown file to an HTML file
❯ ./mdp -infile README.md -outfile readme.html
Installation
Install Go if needed
- If using brew:
brew update
and brew install go
(or brew update go
to get go 1.19)
- Without brew, see directions at https://go.dev/doc/install
Get code and compile
git clone https://github.com/scottbarnes/mdp.git
cd mdp
go build
- Run with
./mdp -infile <filename.md>
Help
❯ ./mdp -h
-infile string
Markdown file to preview
-outfile string
Optional output HTML file
-t string
Alternate template name
Documentation
¶
There is no documentation for this package.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.