Paradox is a Markdown documentation tool for software projects.
It takes a directory tree of markdown files and generates a static documentation site.
This is free and open source software.
Key Features
- Supports GitHub flavored Markdown
- Pages can be organized structured hierarchically. A sidebar with an index or an in-page table of contents can be generated.
- Directives provide additional features over Markdown and allow custom extensions in a principled way
- Variable substitution allows configuring values from your sbt project to be used in the documentation
- Groups allow to create variants of the documentation where parts of pages are only shown when a group is selected e.g. for switching between Scala and Java versions of documentation, snippets, etc.
- Various customization options allow tailoring Paradox’ output to your needs. For example, Themes allow customizing the appearance of Paradox-generated documentation. Custom directives and themes can be packaged and published as separate sbt plugin extensions.
- Validation allows further validation of documentation not available at compile time.
Website: github.com/lightbend/paradox/blob/main/docs/src/main/paradox/index.md
Support: GitHub Code Repository
Developer: Lightbend, Inc
License: Apache 2.0 license
Paradox is written in Scala. Learn Scala with our recommended free books and free tutorials.
Related Software
| Scala Static Site Generators | |
|---|---|
| Scalate | Template engine - HAML, Mustache and JSP, Erb and Velocity style syntaxes |
| Paradox | Markdown documentation tool for software projects |
| Pamflet | Publishing application for short texts |
| Hepek | Collection of useful projects for typesafe HTML construction |
| s2gen | Uses Freemarker as a template engine |
| Ornate | Tool for building multi-page HTML sites from Markdown sources |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |