Skip to main content

GitHub-like local file viewer built with Flask

Project description

HubView — GitHub‑like file viewer (Flask)

A clean, fast, local file viewer with a GitHub‑style UI. Browse folders, preview code with syntax highlighting, render Markdown (tables, task lists, admonitions), show images/video/audio/PDF, and even draw Mermaid diagrams via fenced blocks.

https://github.com/ (UI inspiration only)

ISSUES

  • Many to come

Quick start

  1. pip install hubview
  2. hubview --root 'your directory'
  3. open http://127.0.0.1:5000 in your browser.

Features

  • 🗂️ Directory browsing with breadcrumbs
  • 📝 Markdown rendering with pymdown-extensions (tables, details, tasklists, emoji, etc.)
  • 🧠 Mermaid diagrams via fenced blocks:
    mermaid</code> … <code>
  • 🎨 Client-side syntax highlighting using highlight.js
  • 🖼️ Photo/image preview, plus audio/video and PDF embeds
  • 📖 Auto-render README.md (or index.md) at the bottom of each directory
  • 🛡️ Path safety (jailed to a root folder)
  • 🌗 Looks good in light and dark

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hubview-0.2.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hubview-0.2-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file hubview-0.2.tar.gz.

File metadata

  • Download URL: hubview-0.2.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for hubview-0.2.tar.gz
Algorithm Hash digest
SHA256 e98598d4ab4fc5a4e6319a317471016b1b56dcb2b4dfaecae89a35eabf8f9450
MD5 28f3a6c9d872dc6d43b21b7dc681c346
BLAKE2b-256 fa620275952b155f6c712874d61d1d7439310fe54d8bee5326b1a644c5e93770

See more details on using hashes here.

File details

Details for the file hubview-0.2-py3-none-any.whl.

File metadata

  • Download URL: hubview-0.2-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for hubview-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7f8d5481b9d23ef61c6302ca3de079c359c9e8504c919e34e5449d5041bccedc
MD5 ce211868fdd2d42dcba96fec5a4130d5
BLAKE2b-256 3f37112faebce8137dff35b96e32a6df7d9f32685025f6f92c7aae26e6ee6590

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page