NitroDoc

A system for dealing with Nitrogen documentation.

This will be usable with any Nitrogen-type project, and will focus on searchability and keywords (highlighted within the documentation).

Documentation will be written in a modified markdown (which currently has to be converted from org-mode), to provide things like:

Keyword highlighting for searchability
Record attribute explanations
Function definitions
Automatic breadcrumbs
Differentiation of core vs plugins
Inline Demos? That could be cool.
A nice side-bar type view like erldocs.com (or just using the textbox_autocomplete, not sure yet).
It would be interesting to read from comments, perhaps something like:

%% <nitrodoc record=record_name>
%% <nitrodoc function=function_name>
%% <nitrodoc handler=handler_name>
%% Some documentation
%% </nitrodoc>

But that could be problematic for organization and whatnot. We'll see.

License

MIT License