https://github.com/prime-run/mdhub
https://github.com/prime-run/mdhub
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prime-run/mdhub
- Owner: prime-run
- License: mit
- Created: 2025-08-04T16:47:05.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-08-04T21:12:43.000Z (3 months ago)
- Last Synced: 2025-08-05T11:58:30.663Z (3 months ago)
- Language: CSS
- Size: 1.07 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
mdhub
Render your markdown files local
(github flavored rendering)
> [!NOTE]
> This project is a fork of [go-grip](https://github.com/chrishrb/go-grip)
## :question: About
**mdhub** is a lightweight, Go-based tool designed to render Markdown files locally, replicating GitHub's style. It offers features like syntax highlighting, dark mode, and support for mermaid diagrams, providing a seamless and visually consistent way to preview Markdown files in your browser.
This project is a reimplementation of the original Python-based [grip](https://github.com/joeyespo/grip), which uses GitHub's web API for rendering. By eliminating the reliance on external APIs, mdhub delivers similar functionality while being fully self-contained, faster, and more secure - perfect for offline use or privacy-conscious users.
## :zap: Features
- :zap: Written in Go :+1:
- 📄 Render markdown to HTML and view it in your browser
- 📱 Dark and light theme
- 🎨 Syntax highlighting for code
- [x] Todo list like the one on GitHub
- Support for github markdown emojis :+1: :bowtie:
- Support for mermaid diagrams
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
> [!TIP]> Support of blockquotes (note, tip, important, warning and caution) [see here](https://github.com/orgs/community/discussions/16925)
> [!IMPORTANT]
>
> test
## :rocket: Getting started
To install mdhub, simply:
```bash
go install github.com/prime-run/mdhub@latest
```
> [!TIP]
> You can also use nix flakes to install this plugin.
> More useful information [here](https://nixos.wiki/wiki/Flakes).
## :hammer: Commands and Usage
### Basic Usage
```bash
mdhub [COMMAND]
# mdhub --help
Available commands:
mdhub render FILE - Generate static HTML from markdown
mdhub serve FILE - Serve markdown via local HTTP server
Available Commands:
completion Generate the autocompletion script for the specified shell
emojiscraper Scrape emojis from gist
help Help about any command
render Render markdown document as html
serve Run as a server and serve the markdown file
version Print the version number of mdhub
Flags:
-h, --help help for mdhub
Use "mdhub [command] --help" for more information about a command.
```
### Commands
#### `render` - Generate static HTML Files
Render a markdown file as static HTML.
```
Usage:
mdhub render [file|directory] [flags]
Optional Flags:
--bounding-box Add bounding box to HTML output (default true)
-d, --directory Render all markdown files in directory
-h, --help help for render
-o, --output string Output directory for static files
--theme string Select CSS theme [light/dark/auto] (default "auto")
```
Examples:
```bash
# render a single markdown file (opens it in a new browser tab)
mdhub render README.md
# specify custom output directory
mdhub render README.md -o /path/to/output
# render ALL markdown files in a directory
mdhub render -d /path/to/my-note/ --output ./html-notes/
```
### `serve` - Live Preview Server
Start a local server to render and serve the markdown file.
The server will watch for changes to the file and automatically refresh the browser.
This is useful for live previewing markdown as you edit it.
```
Usage:
mdhub serve FILE [flags]
Flags:
--bounding-box Add bounding box to HTML output (default true)
-b, --browser Open browser tab automatically (default true)
-h, --help help for serve
-H, --host string Host to listen on (default "localhost")
-p, --port int Port to listen on (default 6419)
--theme string Select CSS theme [light/dark/auto] (default "auto")
```
Examples:
```bash
# Start server for live preview of a file
mdhub serve README.md
# Specify host and port
mdhub serve README.md -H 0.0.0.0 -p 8080
# Disable automatic browser opening
mdhub serve README.md -b=false
```
#### `-d/--directory` flag
When passed after the the `render` command, mdhub will:
1. Generate HTML for all markdown files in the directory
2. Create an index page linking to all rendered files
3. Copy all required static assets (CSS, JS, images)
## :pencil: Screen shots
## :bug: TODOs
- [ ] Tests and refactoring
- [ ] Move `theme` selection feature from CLI to a button in rendered HTML
- [ ] Auto `Table of content` generation
- [ ] Purged static files (Opens the door for Single HTML output)
- [ ] Github flavored `blob` support
- [ ] Output to Image
## :pushpin: Similar tools
This tool is a Go-based reimplementation of the original [grip](https://github.com/joeyespo/grip), offering the same functionality without relying on GitHub's web API.