md-preview
This is a tool I threw together over a week when I ran into a case in my workflow that I didn't have
a markdown previewer. Instead of looking for some complicated one I decided to throw together this
project in golang so that it could be a simple CLI tool that I could run from a command line which fits into my workflow quite nicely.
DISCLAIMER: This tool is first and foremost a tool for my own workflow. There are countless improvements that could be added but if it doesn't affect my workflow chances are I won't spend the time to add requested features.
DEMO:

Table of Contents
Installation
Installing with go
For easiest installation, use go install
to install the tool to your go environment.
# Example installation commands if applicable
go install github.com/CryoViking/md-preview@latest
Installing from source
You can also choose to build from source
git clone https://github.com/CryoViking/md-preview.git
cd md-preview
go get -u -v all
go build
go install
Usage
Instructions on how to use the project, including code examples if necessary.
md-preview help
Example:
md-preview ./README.md
Contributing
If this project blows up then I'll figure out a proper process for contributing.
For now tho just follow the following steps (normal for most projects afaik)
- Fork the repository and clone it to your local machine.
- Create a new branch for your feature or bug fix:
git checkout -b feature-branch-name
.
- Make your changes and ensure they are well-tested.
- Commit your changes:
git commit -m "Description of your changes"
.
- Push to the branch:
git push origin feature-branch-name
.
- Submit a pull request to the
master
branch of the original repository.
- Ensure your pull request includes a clear description of the changes made and any relevant information for reviewers.
- After submitting your pull request, a project maintainer (me for now) will review your changes and provide feedback.
- Once your changes are approved, they will be merged into the
master
branch and become part of the project.
License
This project is licensed under the License Name - see the LICENSE file for details.
Features
A brief description of the features of this project.
- Hot Reloading: This tool supports hot reloading of the MD file that you are working on using
fsnotify
in golang and text/event-stream
in the HTML.
- Simple CLI usage.
Roadmap (IDK)
Yeah look... I don't know if I'll keep working on this. I primarily built this for my own use so
as I get annoyed with things I'll make changes and push.
List of potential things I might add:
- Fix the rare occurance of the MD preview not beeing loaded at first.