Skip to main content

Instant local file documentation — point it at any folder and browse

Project description

DocNet

Instant local file wiki. Point it at any folder and get a clean, searchable browser for all your files.

pip install docnet
docnet ~/notes

Features

  • Zero config — just run it in a directory
  • Multi-filetype — markdown, code (20+ languages), CSV, JSON, images, PDFs
  • Full-text search — search filenames and file content with highlighted snippets
  • 5 themes — light, dark, ocean, forest, rose
  • Recent pages — sidebar tracks what you've visited
  • Safe — path traversal protection, never serves files outside the target directory

Usage

docnet                        # serve current directory
docnet ~/notes                # serve a specific folder
docnet ~/notes -p 8080        # custom port
docnet ~/notes --host 0.0.0.0 # expose on local network (share with phone etc.)
docnet ~/notes --no-browser   # don't auto-open browser
docnet --version

File support

Type Extensions
Markdown .md (with mermaid diagrams)
Code .py .js .ts .jsx .tsx .rs .go .java .c .cpp .rb .php .swift .kt .sh .css .scss .html
Data .json .yaml .toml .csv
Images .png .jpg .gif .webp .svg
Documents .pdf .txt .log

Home page

If a Home.md exists in the directory it's shown on launch. Otherwise an auto-generated index of all files is shown.

Install from source

git clone https://github.com/yourname/docnet
cd docnet
pip install -e .

License

MIT

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

docnet-0.1.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

docnet-0.1.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docnet-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1e766a015006eab884f175c3f5c7eeeb7ff7ea85aa344d76e6de49e5ad496f32
MD5 ea98cb0233f6cc3bb0720156823bb791
BLAKE2b-256 0d30728f2d1df3a05140405ee7bccbf818fb2c7f994e78e24781470def1dfeaf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docnet-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for docnet-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ccdf846d795fcb8996f746c37f104b6f702dc781c3908bba29bd1ee29c69c6bb
MD5 decaf26512ec3089f5f33ab6beb99db1
BLAKE2b-256 4c6d8d6c325893943f3c1dae3b587ddfb3cc2568a329a2e42ae6d95a663991cd

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