Nutella with Pepperoni and Mushrooms
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

mandown

0.0.2 • Public • Published

mandown

Documentation system using Markdown.

mandown allows you to document a library using markdown and convert it to a JSON structure that can be rendered, searched and managed easily. This library contains the necessary functionality to work with mandown and convert a file tree of markdown files into one JSON.

Structure

Generally you'll document a single class or function in its own markdown file, and follow the mandown structure for what it should contain. This begins with a top-level header ("h1") with the class the file documents:

# class my_lib::my_class

When this is set, everything "under" this h1 will be part of this class (or function). You can then add any of the following second-level headers (h2's), each with their own specific requirements:

Headers

Describe the header (or list of header files by writing them after each other with a space in-between each):

## Header mylib/my_class.hpp mylib/mylib.hpp

Definition

This is a section which can contain text and code. You can describe the function or class declaration.

## Definition
 
\```c++
template< class T > class my_class_template;
\```

Description

This section contains a description of the class or function. Its purpose and how to use it.

## Description
 
`mylib::my_class_template` wraps a value to be used for ...

Keywords

none

Install

npm i mandown

DownloadsWeekly Downloads

3

Version

0.0.2

License

none

Last publish

Collaborators

  • avatar