https://github.com/munificent/markymark
A tiny static web server for previewing Markdown files
https://github.com/munificent/markymark
Last synced: 5 months ago
JSON representation
A tiny static web server for previewing Markdown files
- Host: GitHub
- URL: https://github.com/munificent/markymark
- Owner: munificent
- License: other
- Created: 2016-11-19T00:41:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-03T03:41:57.000Z (over 3 years ago)
- Last Synced: 2025-04-02T03:14:02.225Z (9 months ago)
- Language: Dart
- Size: 4.88 KB
- Stars: 26
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
I write a lot of Markdown. Like, a *lot* of Markdown. I even wrote a
[whole book][gpp] in it once. Hell, I'm writing some right this very second.
[gpp]: http://gameprogrammingpatterns.com/
When I'm not writing it inside a comment box on Reddit, I'm probably writing
it on my laptop. I've tried a few different "Markdown editors" as well as
Atom's Markdown preview but, well, I like my text editor already. In fact, I
*don't* want to see the rendered Markdown as I type. I like it to be an
explicit (but fast) mode switch because it helps me mentally switch from
writing to reading. That way I read what I *wrote* and not what I *think* I
wrote.
Markymark is a simple solution to that. It's a tiny command line Dart app. It
spins up a little static web server in a directory. Navigate to a Markdown file
and it renders it to HTML. Refresh your browser and it re-renders.
It's also got a little CSS baked that is, to my eye at least, nice looking.
## Installation
Assuming you've already got [Dart][] installed and [pub's bin directory on your
PATH][pub], it's just:
[dart]: https://www.dartlang.org/
[pub]: https://www.dartlang.org/tools/pub/cmd/pub-global
```sh
$ pub global activate markymark
```
## Usage
From any directory, run:
```sh
$ markymark
```
You can also pass an explicit directory path to it:
```sh
$ markymark /some/groovy/directory/
```
Point your browser at `localhost:8080` and you're good to go.
Ctrl-C to kill the server.