mdserver

master branch1 version

master branchlatestOct 1, 2020

github.com/bcardiff/sample-mdserver

No description declared in shard.yml.

0 stars

0 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  mdserver:
    github: bcardiff/sample-mdserver
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal

0.35.1

License

MIT

Author

Brian J. Cardiff <bcardiff@manas.tech>

Target

mdserver from src/mdserver.cr

Dependencies

Runtime Dependencies

markd*github: icyleaf/markd
fswatch*github: bcardiff/crystal-fswatch
live_reload*github: bcardiff/live_reload.cr

README

# mdserver

A sample server that renders markdown on the fly, with [LiveReload](https://github.com/bcardiff/live_reload.cr).

## Installation

```
$ git clone git@github.com:bcardiff/sample-mdserver.git
$ shards build
```

## Usage

```
$ bin/mdserver [dir]
Using data at /full/path/to/dir
Listening on http://127.0.0.1:3000
LiveReload on http://0.0.0.0:35729
```

Open `http://127.0.0.1:3000`.

When the server receives a `GET /file`:

* If a `dir/file.md` exists, it will render it with `dir/styles.css` and livereload script
* Otherwise it will return `dir/file` with a `HTTP::StaticFileHandler`

When changes in `dir` are detected a reload will be sent to the browser.

## Contributors

- [Brian J. Cardiff](https://github.com/bcardiff) - creator and maintainer

mdserver

Installation

shard.yml

Dependencies

Runtime Dependencies

README

Documentation

Links

This branch

Dependents

Repository

Metadata