https://github.com/tsukinoko-kun/serve

Simple file server with a little extra
https://github.com/tsukinoko-kun/serve

file-server markdown-previewer

Last synced: 8 months ago
JSON representation

Simple file server with a little extra

• Host: GitHub
• URL: https://github.com/tsukinoko-kun/serve
• Owner: tsukinoko-kun
• License: other
• Created: 2023-12-26T23:08:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-17T05:56:07.000Z (over 1 year ago)
• Last Synced: 2025-06-28T10:38:28.118Z (about 1 year ago)
• Topics: file-server, markdown-previewer
• Language: Go
• Homepage: https://brew.frankmayer.dev/formula/serve/
• Size: 124 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# serve

[![Test](https://github.com/tsukinoko-kun/serve/actions/workflows/test.yml/badge.svg)](https://github.com/tsukinoko-kun/serve/actions/workflows/test.yml)

Run `serve` to start a webserver hosting the content of a directory.

## Install

### Go install

```bash

go install github.com/tsukinoko-kun/serve@latest

```

### Homebrew

```sh

brew tap tsukinoko-kun/tap

brew install tsukinoko-kun/tap/serve

```

## Usage

```bash

serve [directory] [flags...]

```

## Flags

- `--md`

  Compile Markdown files to HTML

- `--port` `-p` int

  Port to listen on (default is a random port)

- `--verbose` `-v`

  Verbose output