Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gkawamoto/cybermonday

Markdown server without complications.
https://github.com/gkawamoto/cybermonday

docker golang markdown nginx

Last synced: about 8 hours ago
JSON representation

Markdown server without complications.

Awesome Lists containing this project

README

        

# Cybermonday

Markdown server without complications.

## Overview

Simple golang server to host Markdown files without too much complication.
This project was originally based on [https://github.com/russross/blackfriday](https://github.com/russross/blackfriday) (hence the name), but for the sake of simplicity and compliance, it was rewritten to use [https://gitlab.com/golang-commonmark/markdown](https://gitlab.com/golang-commonmark/markdown).

## Quickstart

```bash
docker run --name cybermonday -v $(pwd):/usr/share/nginx/html:ro gkawamoto/cybermonday:stable
```

## Volume

This containers uses a single volume mountpoint to host all the files (markdown or not): `/usr/share/nginx/html`.

## Environment variables

| Variable | Description |
|:-|-:|
| `CYBERMONDAY_TITLE` | Page title in the upper left corner
| `CYBERMONDAY_BOOTSTRAP_REF` | Bootstrap CSS CDN path

## Contributing

Issues and merge-requests are welcome.

## License

MIT License