https://github.com/jmcfarlane/markdown
Simple tool to render and view markdown files locally
https://github.com/jmcfarlane/markdown
browser go golang markdown render
Last synced: about 1 year ago
JSON representation
Simple tool to render and view markdown files locally
- Host: GitHub
- URL: https://github.com/jmcfarlane/markdown
- Owner: jmcfarlane
- Created: 2018-02-02T01:50:13.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T16:17:46.000Z (over 1 year ago)
- Last Synced: 2025-03-29T09:34:22.554Z (about 1 year ago)
- Topics: browser, go, golang, markdown, render
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown
[](https://goreportcard.com/report/jmcfarlane/markdown)
This is a tool to render
[markdown](https://en.wikipedia.org/wiki/Markdown) files locally, for
use with iteration prior to pushing changes to version control.
1. All markdown rendering occurs locally
## Installation
```sh
$ go install github.com/jmcfarlane/markdown@latest
```
## Usage
```sh
$ cd ~/where/your/docs/are
$ markdown
```
Point your browser at: http://localhost:8080. Click around, refresh
the page as you make changes.
## Help
```sh
$ markdown -h
Usage of markdown:
-index string
Index (or default) markdown file name (default "README.md")
-listen string
Interface:port to listen on (default ":8080")
```
## Credit
This program doesn't really do much of anything. All the actual work
is done by:
- [github.com/alecthomas/chroma](https://github.com/alecthomas/chroma)
- [github.com/gomarkdown/markdown](https://github.com/gomarkdown/markdown)
- [golang.org](https://golang.org)
As well as things ^ depend upon.
> Inspired by: https://github.com/joeyespo/grip