@mtscout6/markserv
markserv serves Markdown files as GitHub style HTML and LiveReloads your files in the browser as you edit.
Last updated 3 years ago by mtscout6 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @mtscout6/markserv 
SYNC missed versions from official npm registry.

markserv

markserv serves Markdown files as GitHub style HTML and LiveReloads your changes in the browser as you edit.

Live editing example

Why Does It Exist?

markserv is designed to replace a Apache + Marked2 workflow.

I purchased Marked2 after seeing a colleage use it to edit markdown content. It looked awesome, but it felt clunky. And it didn't integrate with my almost constant CLI usage. While I found Marked2 to have a very well-rounded feature set, it was simply too slow, and too memory intensive.

Features

  • Basic HTTP server that indexes directories
  • HTTP server renders Markdown files as HTML
  • Markdown rendered with GitHub flavor CSS
  • Markdown rendered with GitHub style syntax highlighting
  • LiveReload updates the view when your files change
  • Links to external Markdown files are re-written and followed by the server

Installing

Install the markserv server via npm.

npm install markserv -g

Usage

Change to the directory of your CLI

cd path/to/serve/from

Start the HTTP markdown server in the current directory on port 8080

markserv

You should see something like this:

markserv CLI output

Click on the address link such as http://0.0.0.0:8080 in your terminal to open the browser and index the directory:

Showing Indexes in markserv

In the browser, click on a Markdown file, like "README.md", and markserv should render the Markdown file as HTML in your browser.

Expected output

Watch your CLI for server hints:

  • Diretory Indexes
  • Files Served
  • Markdown file updates
  • Errors

markserv CLI being chatty

Realtime/Live editing

Edit your markdown file, and you should now see the page reloading as you save your Markdown file. It should save your scroll position, which helps when editing extemely large documents.

Live editing example

Linking to an external Markdown file

You can link to an external Markdown file in the same way that you use GitHub Wiki links. You can use the example code here to see how external links work.

Example code:

[Skateboarding Dog!](Linked-Markdown-Example.md)

Example link:

Skateboarding Dog!

Using With Auto-Save for SublimeText

Coming soon...

https://packagecontrol.io/packages/auto-save

Options/Flags

To list the options/flags for the markserv CLI tool:

markserv --help

Changing the HTTP Directory

You can serve content from a different path using the following command:

markserv -h /path/to/dir

Changing the HTTP Port

You can change the HTTP Port like this:

markserv -p 80

Pre-Requisites

  • Node.js & NPM
  • Web Browser
  • Text Editor

How does it work?

markserv watches for file updates to the markdown file, and to the CSS directory, and automatically reloads the Markdown page via LiveReload. markserv remembers the scroll position you were at in the web browser, and reloads the page with the same scroll position when you make changes.

markserv was built for working on projects that contain a combination of web content and Markdown, where the markdown gets reloaded on the fly as the file is saved in your text editor. But it also serves regular HTTP content, replacing the need for a more bulky web server setup using MAMP, etc.

Credits

Logo Credits

Markdown Icon

Markdown Icon | Octicon Icons by Github

File Icon

File icon | Linecon by W3 Creative Labs

Folder Icon

Folder icon | Hawcons by Yannick Lung

Current Tags

  • 0.0.17                                ...           latest (3 years ago)

1 Versions

  • 0.0.17                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (15)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |