Giter Club home page Giter Club logo

nmd's Introduction

nmd

This is a fork of nmd which migrates to mistune v3 (from v2)

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.

nmd's People

Contributors

rycee avatar horriblename avatar ncfavier avatar alexarice avatar kovirobi avatar ma27 avatar thiagokokada avatar sternenseemann avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.