Skip to content

A simple utility to list files and render GitHub Flavored Markdown

License

Notifications You must be signed in to change notification settings

fa7ad/gfm-serve

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gfm-serve

A simple serve like utility to list files and render GitHub Flavored Markdown.

Installation

$ go install github.com/fa7ad/gfm-serve/cmd/gfm-serve

Or, clone the repo and build the binary.

$ git clone https://github.com/fa7ad/gfm-serve.git
$ cd gfm-serve
$ make

The binary will be available in the out directory.

Usage

$ gfm-serve --help
NAME:
   gfm-serve - Serve GitHub Flavored Markdown files

USAGE:
   gfm-serve [global options] command [command options] [arguments...]

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --port value, -p value, -P value       Port number to listen on (default: 8080)
   --directory value, -d value, -D value  Path to serve files from (default: ".")
   --addr value, -a value, -A value       Hostname/Address to listen on (default: "localhost")
   --help, -h                             show help