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.1.0.tar.gz (10.5 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.1.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hubview-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8ad9ec67f5321f17d2eba7a58c00570147bd0274eb9ef02749513dd7bfe8d886
MD5 78d9d54908f3660efdd360c18986cb10
BLAKE2b-256 f57b017f49f4d63d945f648086e674d3f23171e9408c3ed3f51f0300f1ddb4bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hubview-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.2 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f41c25f74227ede46d01bd474ce68d71a50f715f2fb9231c913f0cf7c34a785d
MD5 21eb74cd8b0e34d85c89f1904b1df012
BLAKE2b-256 c96151a0a862d2be98e940fc9c3401896fbe27e7d74f585d4823de4c5096ba1d

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