https://github.com/fa7ad/gfm-serve
A simple utility to list files and render GitHub Flavored Markdown
https://github.com/fa7ad/gfm-serve
github-flavored-markdown go golang markdown static-file-server
Last synced: 8 months ago
JSON representation
A simple utility to list files and render GitHub Flavored Markdown
- Host: GitHub
- URL: https://github.com/fa7ad/gfm-serve
- Owner: fa7ad
- License: bsd-3-clause
- Created: 2023-04-23T22:02:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-28T19:50:40.000Z (almost 3 years ago)
- Last Synced: 2025-03-30T17:28:16.884Z (12 months ago)
- Topics: github-flavored-markdown, go, golang, markdown, static-file-server
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gfm-serve
A simple [serve] like utility to list files and render GitHub Flavored Markdown.
## Installation
```sh
$ go install github.com/fa7ad/gfm-serve/cmd/gfm-serve
```
Or, clone the repo and build the binary.
```sh
$ git clone https://github.com/fa7ad/gfm-serve.git
$ cd gfm-serve
$ make
```
The binary will be available in the `out` directory.
## Usage
```sh
$ 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
```
[serve]: https://npm.im/serve