Self-host PineDocs
1.2.5Lightweight file viewer for documentation and wikis
- Stars
- 142
- Port
- 80 (HTTP web server)
xy2z/pinedocsWhat is PineDocs?
PineDocs is a fast, lightweight, self-hosted site for viewing files from a directory. It renders Markdown, plaintext, HTML, and code with syntax highlighting for many languages, plus images, vector graphics, animated images, mathematical notation, PDFs, audio, and short video clips — essentially anything a browser can display. No database is required; files are cached in the browser after first view for instant loads. It supports responsive layouts with several color schemes including a dark variant, quick filtering, hidden folders accessible via direct links, and remembers scroll position per page. The project is read-only — content is edited on the server or via git, not through a web UI. It can be deployed via Docker Compose (recommended), plain Docker, or manually on any PHP 8.0+ web server with Composer. Configuration is done through a YAML file controlling title, content directory, layout, color scheme, code highlighting theme, file exclusions, and more. The latest release is 1.2.5 from May 2022; the repository was last pushed in March 2023.
Should you self-host PineDocs?
PineDocs scores 43/100 on selfhost.directory (how scoring works) and ranks #2 of 2 in Documentation Management. It has 142 GitHub stars.
There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.
Setup is easy: most people get it running in one sitting. An official Docker image is available. It is GPL-3.0-licensed and written mostly in PHP.
Its closest alternative on selfhost.directory is CodeX.docs (55/100, 846 stars). It scores higher overall, so compare the two before you pick. See PineDocs vs CodeX.docs side by side.
Features
- Client-Side Caching
- Configurable via YAML
- Custom CSS/JS
- File exclusion with regex
- File viewing
- Git repository support
- Hidden folders
- MathJax support
- Multiple color schemes
- Multiple layouts
- No Database Required
- Quick filtering
- Scroll position memory
- Syntax highlighting
PineDocs README
More in Documentation Management
pkgsitepkgsite is a self-hosted Helm chart deploying a private pkg.go.dev instance on Kubernetes with PostgreSQL, Redis, and optional Athens proxy for private Go modules.
RackPeekSelf-hosted web UI and CLI for home lab infrastructure documentation, tracking hardware, services, and networks in open YAML formats.
RanetoSelf-hosted, open-source Markdown wiki and knowledge base for Node.js: file-based pages, in-browser editor, Lunr search, login protection, Docker image, no database.
scalarAn open-source platform for API docs and testing: self-hosted API references from OpenAPI/Swagger specs via a Docker image, plus an offline-first API client.
ShowDocSelf-hosted online API documentation and technical documentation tool for IT teams. Create beautiful API docs, data dictionaries, technical specs with Markdown support.
The-One-FileSelf-hosted offline-first network topology editor in a single HTML file with optional Docker collaboration.
TypemillOpen-source, self-hosted flat-file CMS for documentation sites, manuals and knowledge bases: write Markdown, publish websites, PDFs and EPUBs, no database needed.
Wiki.jsWiki.js is a self-hosted, open-source wiki engine with a live-preview markdown editor, two-way Git sync and OIDC/LDAP/SAML sign-in, running on Node.js plus PostgreSQL.
wikmdFile-based markdown wiki with knowledge graphs, dark theme, drawio/PlantUML plugins, and git integration. Files instead of database. Self-host via Docker or Python.
An Otter WikiA minimalistic wiki powered by python, markdown and git.
AzimuttOpen-source, self-hosted database explorer and Next-Gen ERD: design schemas with AML, document tables and columns, browse data and lint large, messy databases.
BackstageSelf-hosted, open-source developer portal framework born at Spotify and now CNCF-hosted: central software catalog, TechDocs docs-as-code, service templates, plugins.
0 comments