docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
Read more
Tag: documentation
godoc-lint – linter for consistent Go documentation
godoc-lint checks Go documentation against consistent comment practices, with configurable rules and integration with Golangci-lint.
Read more
Daux.io – Markdown Documentation Generator
Daux.io turns Markdown files and folders into structured documentation websites with navigation, themes, syntax highlighting and static output.
Read more
Best Free and Open Source Alternatives to Adobe RoboHelp
Best free and open source alternatives to Adobe RoboHelp for creating technical documentation, online help, and knowledge bases on Linux.
Read more
10 Best Free and Open Source API Documentation Browsers
Software developers need all the help possible. One useful tool is a documentation browser. In fact, they can sometimes be a life changer.
Read more
Otter Wiki – Git-backed wiki
Otter Wiki is a Git-backed wiki with Markdown editing, page history, attachments, transclusion and access controls for documentation.
Read more
LeafWiki – lightweight Markdown wiki
LeafWiki is a lightweight Markdown wiki with tree navigation, page links, search, revisions and user management for documentation.
Read more
15 Best Free and Open Source Linux Documentation Generators
A documentation generator is a programming tool that generates documentation intended for programmers and end users.
Read more
Starlight – documentation website framework for Astro
Starlight builds Astro-powered documentation websites with built-in search, multilingual navigation, accessible layouts and MDX support.
Read more
Antora – modular documentation site generator
Antora assembles versioned AsciiDoc documentation websites from Git repositories, with modular components, navigation and custom interfaces.
Read more
CoWeM – static site generator for course websites
CoWeM generates course websites, lecture notes and slides from Markdown, with conditional content, LaTeX maths and SCORM exports.
Read more
Znai – build functional, maintainable, beautiful user guides
Znai generates documentation websites from Markdown, combining code snippets, API references, diagrams, instant search and live preview.
Read more
YARD-Lint – linter for Ruby YARD documentation
YARD-Lint checks Ruby YARD documentation for completeness, correctness and consistency, with diff workflows, and coverage checks.
Read more
tiki – documentation and issue management tool
Tiki is a lightweight terminal-based project and knowledge management tool designed to work directly inside a Git repository.
Read more
Wiki-Go – flat-file wiki
Wiki-Go is a flat-file wiki with Markdown, hierarchical pages, full-text search, revision history and Kanban boards for documentation.
Read more
tbls – CI-friendly tool to document a database
tbls (pronounced /ˈteɪbl̩z/) is a CI-Friendly tool to document a database.
Read more
dirmap – generate annotated directory maps from source files
dirmap generates annotated directory maps from Markdown and source comments, with configurable matchers, ignore patterns, and table output.
Read more
termframe – render terminal output as SVG screenshots
termframe renders commands and piped terminal output into styled SVG screenshots, supporting colours, automatic sizing and custom themes.
Read more
Docmost – collaborative documentation wiki
Docmost is a collaborative documentation wiki with real-time editing, team spaces, comments, diagrams and search for documentation.
Read more
explainshell – match command-line arguments to their help text
explainshell is a tool (with a web interface) which parses man pages, extracts options and explains a given command-line by matching each argument to the relevant help text in the man page.
Read more