Nimiq Documentation Theme

Motivation

For the Nimiq Blockchain we wanted to design a documentation theme which has the following properties:

Installation

In your project’s root folder create a _config.yml like this:

remote_theme: nimiq/doc-theme
title: "Nimiq"
description: "Developer Reference"

Your readme.md will become your index.html.

Format

Real World Examples