Skip to content

dkchw/mdserve

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdserve

A beautiful local file server with Markdown rendering. Like python -m http.server but with style.

Install

uv tool install .

Usage

# Serve current directory on port 2112
mdserve

# Custom port
mdserve 8080

# Custom bind address
mdserve 2112 --bind 127.0.0.1

Features

  • 📁 File browser — clean directory listing with file icons, sizes, and dates
  • 📄 Markdown rendering — beautiful typography with syntax-highlighted code blocks
  • ☀/☽ Light & dark mode — toggle in the top bar, preference saved to localStorage
  • 🗂 Table of contents — auto-generated sidebar for Markdown files with headings
  • 🔒 Safe — path traversal protection, stays within the served directory
  • No configuration — just run it

License

Apache License 2.0. See LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors