Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/docker-madness
Docker Image for the Madness Markdown Server
https://github.com/dannyben/docker-madness
documentation-tool markdown markdown-server
Last synced: 30 days ago
JSON representation
Docker Image for the Madness Markdown Server
- Host: GitHub
- URL: https://github.com/dannyben/docker-madness
- Owner: DannyBen
- Created: 2017-03-25T16:04:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T08:10:15.000Z (9 months ago)
- Last Synced: 2024-10-06T05:29:53.798Z (about 1 month ago)
- Topics: documentation-tool, markdown, markdown-server
- Language: Ruby
- Homepage: http://madness.dannyb.co
- Size: 17.6 KB
- Stars: 18
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker Madness Markdown Server
> **REPOSITORY DEPRECATION NOTICE**
> This repository is now merged into the [madness](https://github.com/DannyBen/madness)
> repository. Please refer to it instead.
---
This is a dockerized version of the [Madness markdown server ruby gem][1].
It allows you to start a webserver that shows your markdown documentation
folder.
## Usage
The easiest way to use this image, is to create a shell alias:
```shell
$ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness'
$ madness --help
```
### Use with docker-compose
Put this in your `docker-compose.yml`:
```yaml
# docker-compose.yml
services:
web:
image: dannyben/madness
volumes: [".:/docs"]
ports: ["3000:3000"]
command: server
```
Then run:
```shell
$ docker-compose up
```
## Additional Information
- [Madness Home][4]
- [Madness Gem on GitHub][1]
- [Madness Gem on RubyGems][5]
- [Madness Docker Image on Docker Hub][2]
- [Madness Docker Source on GitHub][3]
---
[1]: https://github.com/DannyBen/madness
[2]: https://hub.docker.com/r/dannyben/madness/
[3]: https://github.com/DannyBen/docker-madness
[4]: http://madness.dannyb.co/
[5]: https://rubygems.org/gems/madness