A modern documentation reader inspired by Unix man pages, designed to make software documentation accessible, searchable, and maintainable.
Note
Neoman is currently in early development. Expect frequent updates and changes as we refine the experience.
curl https://raw.githubusercontent.com/inodaf/neoman/refs/heads/main/install.sh | bashThe installer will request permission to configure the nman.local domain in your /etc/hosts file for the best experience.
After installation, you can read Neoman's documentation using Neoman itself:
nman inodaf/neomanFinding and reading documentation for your software stack shouldn't be a hassle. Neoman brings back the simplicity of Unix man pages while adding modern features for today's development workflows.
Focus on writing great docs, not managing infrastructure. No servers to maintain, no hosting costs, no deployment pipelines. Just write Markdown and push to Git.
Documentation stays in sync with your code automatically. Push to any Git provider (GitHub, GitLab, etc.) and readers get updates instantly.
Create a /docs directory with an index.md file and additional .md files. That's enough for software maintainers to adopt Neoman.
All your organization's documentation in one searchable place. Use full-text search across all docs or filter by specific projects.
nman inodaf/neomanEverything runs locally on your machine. No data leaves your device, perfect for private organizational documentation.
Share documentation with colleagues using local URLs like https://nman.local/inodaf/neoman. Perfect for README badges:
