ReadEm

Python HTTP Server special for markdown.


Keywords
readme markdown documentation
License
GPL-3.0-only
Install
pip install ReadEm==0.1.4

Documentation

ReadEm

HTTP server for readme files.

Read local README.md or any markdown file easily. Will be useful for clone wiki of github repository or the repo clone with markdown files. Basicly any .md (markdown) file.

Markdown files on current directory will be shown on navbar menu. :)

Instalation

$ pip3 install ReadEm

Run

ON_A_DIRECTORY: $ python3 -m ReadEm.serve -h
usage: .py [-h] [--bind ADDRESS] [port]

positional arguments:
  port                  Specify alternate port [default: 8000]

optional arguments:
  -h, --help            show this help message and exit
  --bind ADDRESS, -b ADDRESS
                        Specify alternate bind address [default: 127.0.0.1]

ON_A_DIRECTORY: $ python3 -m ReadEm.serve
Listening on 127.0.0.1:8000
Press CTRL+c to stop
127.0.0.1 - - [22/Dec/2017 14:24:40] "GET / HTTP/1.1" 200 -
127.0.0.1 - - [22/Dec/2017 14:45:17] "GET /README.md HTTP/1.1" 200 

Credit