Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/markserv/markserv

🏁 serve markdown as html (GitHub style), index directories, live-reload as you edit
https://github.com/markserv/markserv

cli directory files-served gfm github highlighting html include indexes live-reload livereload markdown markdown-it markserv markserv-cli md realtime server syntax templating

Last synced: 24 days ago
JSON representation

🏁 serve markdown as html (GitHub style), index directories, live-reload as you edit

Host: GitHub
URL: https://github.com/markserv/markserv
Owner: markserv
License: mit
Created: 2016-10-04T17:58:33.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-05-13T22:59:08.000Z (6 months ago)
Last Synced: 2024-05-13T23:45:51.747Z (6 months ago)
Topics: cli, directory, files-served, gfm, github, highlighting, html, include, indexes, live-reload, livereload, markdown, markdown-it, markserv, markserv-cli, md, realtime, server, syntax, templating
Language: CSS
Homepage: https://f1lt3r.io
Size: 7.33 MB
Stars: 509
Watchers: 12
Forks: 81
Open Issues: 44
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        


	



> :checkered_flag: serve markdown as html (GitHub style), index directories, and live-reload as you edit

[![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-FF69B4.svg?style=flat-square&logo=gitter-white&link=https://gitter.im/markserv)](https://gitter.im/markserv)

[![CHANGELOG](https://img.shields.io/badge/changelog- ✔️-orange.svg?style=flat-square)](CHANGELOG.md)

[![Build Status](https://travis-ci.org/markserv/markserv.svg?branch=master&style=flat-square)](https://travis-ci.org/markserv/markserv)

[![Coverage Status](https://coveralls.io/repos/github/markserv/markserv/badge.svg?branch=master&style=flat-square)](https://coveralls.io/github/markserv/markserv?branch=master) [![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors) [![Npm Version](https://img.shields.io/npm/v/markserv.svg?style=flat-square)](https://www.npmjs.com/package/markserv)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square)](https://github.com/sindresorhus/xo)

[![Known Vulnerabilities](https://snyk.io/test/github/markserv/markserv/badge.svg?style=flat-square)](https://snyk.io/test/github/markserv/markserv)



	



## :sparkles: Features

- Markdown content rendered as HTML

- GitHub flavor CSS and Syntax Highlighting

- [Just in Time Templating](#stopwatch-just-in-time-templating): Markdown, HTML & LESS

- LiveReload as you edit

- Directory indexes

- MIME Type file support

Supporting: [MathJax](tests/mathjax.md), [Chinese Characters](tests/测试.md), [Table of Contents](tests/toc.md), [Tables](tests/tables.md), [Heading Anchors](tests/links.md)



	



## :computer: Installation

```shell

# NPM

$ npm i -g markserv

# Yarn

$ yarn global add markserv

```

## :joystick: Usage

To start Markserv from the CLI

```shell

# Open closest README.md

$ readme

# Open file

$ markserv README.md

# Open a directory

$ markserv node_modules

```



	



Start Markserv and open a file or directory.

```shell

# File

$ markserv ./path/to/file.md

# Directory

$ markserv ./

```

Start Markserv and open the closest README.md file in the browser:

```shell

$ readme

```

## :zap: Live Reload

To see real-time updates as you save your markdown files, you will need to install the LiveReload plugin for your browser:

- [Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)

- [Firefox](https://addons.mozilla.org/addon/livereload-web-extension/)

- [Internet Explorer](https://github.com/dvdotsenko/livereload_ie_extension)

With the Live Reload plugin installed and turned on, you should see the page reloading as you save your Markdown file.



	



## :link: Markdown Links

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:

```markdown

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

```

Example link:

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

## :stopwatch: Just in Time Templating

Markserv allows you to include nested content. Templates are fetched and rendered when you request them in your browser. The `maxDepth` of includes is set to `10`.

If you would like to look at an example, you can look in the [tests/templates](tests/templates/) directory of this repo.

To see the server output of this templating example:

```shell

$ git [email protected]/f1lt3r/markserv.git

$ cd markserv

$ markserv tests/templates/index.html

```

### Include Markdown

Note: Any markdown files that you include will be transformed to HTML.

Where `foo/bar/baz/qux.md` equals:

```markdown

## Qux

```

And Markserv renders the following content:

```markdown

# Include Markdown

{markdown: foo/bar/baz/qux.md}

```

The server response will be:

```html

Include Markdown

Foo Bar

```

### Include HTML

Where `foo/bar/baz/qux.html` equals:

```html

Qux

```

And Markserv renders the following content:

```markdown

# Include Markdown

{html: foo/bar/baz/qux.html}

```

The server response will be:

```html

Include Markdown

Qux

```

### Include LESS

Note: Any LESS files that you include will be transformed to CSS.

Where `foo/bar/baz/qux.css` equals:

```less

@link-color: green;

a {color: @link-color}

```

And Markserv renders the following content:

```html

{less: foo/bar/baz/qux.css}

```

The server response will be:

```css

a {

  color: #008000;

}

```

## :crossed_flags: Flags

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

```shell

$ markserv --help

```

### Changing the HTTP Port

You can change the HTTP Port like this:

```shell

markserv -p 80

```

### Making Markserv available to external networks

In some cases `localhost` might be the address on which the server is listening, in which case it is hard to make the site available to external networks even with the right IP. Use the following as an example to make sure the server is accessible from external networks:

```shell

markserv -p 8642 -a 0.0.0.0

```

Above example runs the server on port `8642` and it can be accessed from external networks using public IP of the machine on which the server is running. If you want the server to keep running in a seperate thread even when you log out, use this:

```shell

nohup markserv -p 8642 -a 0.0.0.0 &

```

This will make the server instance persistent and will be available to access even when you log out or even when your ssh session closes (in case you are accessing a remote machine through ssh to set up `markserv` server)

## :cupid: Credits

- Logos used in the directory list: [PKief - vscode-material-icon-theme](https://github.com/PKief/vscode-material-icon-theme)

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Alistair MacDonald}
💻

    
_陳瀛洲
💻

    
_{Kefei Lu}
💻

    
_{Zhenfei You}
💻

    
_Andrew
💻

    
_{Daniel Perez}
💻

    
_{Sushruth Shastry}
💻

  

  

    
_{Patryk Rzucidło}
💻

    
_EstebanMarin
💻

    
_{Matthew Reishus}
📖

    
_{Daniel Wennberg}
💻

    
_{Pete Hodgson}
💻

    
_{Deleted user}
📖

    
_{Liam Dawson}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!