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 |
| Metabrowse | Static site generator for code search |
| Ornate | Tool for building multi-page HTML sites from Markdown sources |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.