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.
- 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.
|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.|
|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 make informed decisions.|
|Hundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information.|
|Alternatives to Google's Products and Services examines your options to migrate from the Google ecosystem with open source Linux alternatives.|
|Alternatives to Microsoft's Products and Services recommends open source Linux software.|
|Alternatives to Adobe Cloud looks at free and open source alternatives to products available from Adobe Cloud's subscription service.|
|Alternatives to Apple recommends free and open source alternatives to Apple's proprietary world.|
|Alternatives to Corel surveys alternatives to Corel's range of graphics processing products and other software applications.|
|Getting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers.|
|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.|
|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.|
|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.|
|Stars and Stripes is an occasional series looking at the impact of Linux in the USA.|