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
• HTML rendering — .html files render live, with a toggle to view source
• Live reload — edit a file on disk and the open page refreshes itself
• Reader mode — hide the sidebar for a clean, website-like view (--reader or the ☰ button)
• 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
• Quality of life — copy buttons on code blocks, hover anchors on headings, per-file download
• 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 --reader       # start with the sidebar hidden (website-like)
docnet ~/notes --no-browser   # don't auto-open browser
docnet --version

File support

Run from Python

Instead of the CLI, you can launch DocNet from a script:

from docnet import serve

serve("~/notes", port=8080, reader=True)   # blocks until Ctrl+C

serve() accepts directory, port, host, reader, open_browser, and debug. Pass open_browser=False to skip auto-opening a tab (e.g. headless).

Need the raw Flask app (for gunicorn/uWSGI or tests)? Use the factory:

from docnet import create_app

app = create_app("~/notes")   # a standard Flask app

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