Sign inSign up

sanderhd/docs-webui

By sanderhd

โ€ขUpdated about 1 year ago

A fully custom, self-hosted GitBook-style Markdown documentation server.

Image
Web servers
0

253

sanderhd/docs-webui repository overview

โ ๐Ÿ“š GitBook Custom

A lightweight, self-hosted documentation server built entirely from scratch with Node.js.
It converts Markdown files into clean, responsive HTML pages โ€” no frameworks like Docsify or MkDocs required.


โ โœจ Features

  • ๐Ÿ”น Dynamic Markdown โ†’ HTML rendering
  • ๐Ÿ”น File-based routing (/docs/README.md โ†’ /)
  • ๐Ÿ”น Simple sidebar navigation
  • ๐Ÿ”น Fully customizable CSS and layout
  • ๐Ÿ”น Lightweight and fast โ€” ideal for CasaOS or Raspberry Pi

โ โš™๏ธ Usage

docker run -d   --name gitbook-custom   -p 3000:3000   -v $(pwd)/docs:/app/docs   sander/gitbook-custom:latest

๐Ÿ‘‰ Open http://localhost:3000โ  after starting the container.


โ ๐Ÿ“‚ Volumes

PathDescription
/app/docsYour Markdown documentation folder

โ ๐Ÿงฑ Ports

HostContainerDescription
30003000Web UI

โ ๐Ÿ› ๏ธ Built With

Node.js โ€ข Express โ€ข Marked


โ ๐Ÿงก Made for CasaOS

Tag summary

Content type

Image

Digest

sha256:6beeec219โ€ฆ

Size

47.4 MB

Last updated

about 1 year ago

docker pull sanderhd/docs-webui