spikespaz / nixoptdoc

A fork of https://sr.ht/~rycee/nmd/, do not use yet.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nmd

Introduction

The nmd project is a standalone version of the documentation system inside NixOS. It has been refactored to make it easier to generate documentation for other projects that use the NixOS module system.

Note, this project is still immature and lack some features.

Bug Reports and Sending Patches

Bug reports and patches are managed through my sourcehut public inbox and nmd tickets.

Development

The code is formatted using nixfmt. The formatting can be applied by running

$ nix develop -c p-format

Examples

The examples directory gives some demonstration of how to use nmd. The examples can be built using nix-build, for example,

$ nix-build ./example/minimal -A html

Example output

Home Manager Manual

rycee's NUR manual

License

This project is licensed under the terms of the MIT license.

About

A fork of https://sr.ht/~rycee/nmd/, do not use yet.

License:MIT License


Languages

Language:Nix 38.7%Language:Python 25.5%Language:XSLT 19.2%Language:SCSS 12.6%Language:JavaScript 2.0%Language:Shell 1.9%