https://github.com/nitrogen/nitrodoc
Nitrogen-based documentation system
https://github.com/nitrogen/nitrodoc
Last synced: 4 months ago
JSON representation
Nitrogen-based documentation system
- Host: GitHub
- URL: https://github.com/nitrogen/nitrodoc
- Owner: nitrogen
- Created: 2016-03-24T02:48:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-01T23:54:52.000Z (over 10 years ago)
- Last Synced: 2025-02-28T00:56:49.144Z (over 1 year ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
1. Keyword highlighting for searchability
2. Record attribute explanations
3. Function definitions
4. Automatic breadcrumbs
5. Differentiation of core vs plugins
6. Inline Demos? That could be cool.
7. A nice side-bar type view like erldocs.com (or just using the textbox_autocomplete, not sure yet).
8. It would be interesting to read from comments, perhaps something like:
```erlang
%%
%%
%%
%% Some documentation
%%
```
But that could be problematic for organization and whatnot. We'll see.
# License
Copyright 2016 Jesse Gumm
MIT License