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.
Features include:
- 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.
Return to Scala Static Site Generators
| Popular series | |
|---|---|
 | The largest compilation of the best free and open source software in the universe. Each article is supplied with a legendary ratings chart helping you to make informed decisions. |
 | Hundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information. |
 | The Big List of Active Linux Distros is a large compilation of actively developed Linux distributions. |
 | Replace proprietary software with open source alternatives: Google, Microsoft, Apple, Adobe, IBM, Autodesk, Oracle, Atlassian, Corel, Cisco, Intuit, and SAS. |
 | Awesome Free Linux Games Tools showcases a series of tools that making gaming on Linux a more pleasurable experience. This is a new series. |
 | Machine Learning explores practical applications of machine learning and deep learning from a Linux perspective. We've written reviews of more than 40 self-hosted apps. All are free and open source. |
 | New to Linux? Read our Linux for Starters series. We start right at the basics and teach you everything you need to know to get started with Linux. |
 | Alternatives to popular CLI tools showcases essential tools that are modern replacements for core Linux utilities. |
 | Essential Linux system tools focuses on small, indispensable utilities, useful for system administrators as well as regular users. |
 | Linux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine. |
 | Surveys popular streaming services from a Linux perspective: Amazon Music Unlimited, Myuzi, Spotify, Deezer, Tidal. |
 | Saving Money with Linux looks at how you can reduce your energy bills running Linux. |
 | Home computers became commonplace in the 1980s. Emulate home computers including the Commodore 64, Amiga, Atari ST, ZX81, Amstrad CPC, and ZX Spectrum. |
 | Now and Then examines how promising open source software fared over the years. It can be a bumpy ride. |
 | Linux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged. |
 | Linux Candy reveals the lighter side of Linux. Have some fun and escape from the daily drudgery. |
 | Getting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers. |
 | Best Free Android Apps. We showcase free Android apps that are definitely worth downloading. There's a strict eligibility criteria for inclusion in this series. |
 | These best free books accelerate your learning of every programming language. Learn a new language today! |
 | These free tutorials offer the perfect tonic to our free programming books series. |
 | Linux Around The World showcases usergroups that are relevant to Linux enthusiasts. Great ways to meet up with fellow enthusiasts. |
 | Stars and Stripes is an occasional series looking at the impact of Linux in the USA. |