| 1 | Doxx — static docs generator
|
| 2 | ======================
|
| 3 |
|
| 4 | > Originally created as part of the Resin.io documentation repository, the code is now extracted and generalized.
|
| 5 |
|
| 6 | Doxx is an opinionated yet flexible static generator for technical documentation.
|
| 7 |
|
| 8 | Doxx was created at Resin.io to address the requirements (some of them unique) we have for our docs:
|
| 9 | * author docs in Markdown,
|
| 10 | * use Handlebars templates inside of the docs files, with support for partials (DRY FTW),
|
| 11 | * generate "dynamic" pages by expanding the skeleton page over a combination of parameters, and be able to override parts of such pages for specific params combinations,
|
| 12 | * use powerful templating language (Swig in our case) for pages layouts,
|
| 13 | * generate static docs, but also be able to reuse the same layouts for a couple of dynamic routes (like server-rendered search results),
|
| 14 | * easily define navigation tree using the simple plain-text format,
|
| 15 | * easily render breadcrumbs that reflect the page position in the navigation tree.
|
| 16 |
|
| 17 |
|
| 18 | License
|
| 19 | -------
|
| 20 |
|
| 21 | The project is licensed under the Apache 2.0 license.
|