https://github.com/michael/ndogen-client
On-the-fly documentation generation powered by ndogen
https://github.com/michael/ndogen-client
Last synced: about 1 year ago
JSON representation
On-the-fly documentation generation powered by ndogen
- Host: GitHub
- URL: https://github.com/michael/ndogen-client
- Owner: michael
- Created: 2010-06-27T18:05:37.000Z (almost 16 years ago)
- Default Branch: master
- Last Pushed: 2010-08-27T20:59:25.000Z (almost 16 years ago)
- Last Synced: 2025-02-14T01:45:58.435Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 454 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ndogen-client
===================
A viewer for a all-new ambitious [source documentation format](http://github.com/oliver----/ndogen). ;-)
Ndogen exposes documentation as data (JSON) instead of pre-rendered HTML.
This approach not only saves some bytes at transmission, it also allows clients to individually render the result.
I'll start with a clean document output format, with some unobtrusive interaction (navigation, search, etc.).
ndogen Syntax (Early Draft)
-------------------
NDOGEN - Natural text markup
=================================================================
Ndogen exposes documentation as data (JSON) instead of pre-rendered HTML.
This approach not only saves some bytes at transmission, it also allows
clients to individually render the result.
Block Elements
-----------------------------------------------------------------
Paragraph
.................................................................
A paragraph is simply one or more consecutive lines of text, separated
by one or more blank lines. Normal paragraphs should not be indented with
spaces or tabs.
Sections
.................................................................
Sections, inspired by the Setext-style, are “underlined” using equal signs
(for first-level sections) and dashes (for second-level sections) or dots
(third-level sections).
For example:
$ Section 1
$ =============
$
$ Section 2
$ -------------
$
$ Section 3
$ .............
Unordered Lists
.................................................................
Ndogen supports nested lists and hanging indents.
$ * Red
$ * Green
$ Additional Line
$ * Dark Green
$ * Light Green
$ * Blue
Ordered Lists
.................................................................
$ # Red
$ # Green
$ Additional Line
$ # Dark Green
$ # Light Green
$ # Blue
Code Blocks
.................................................................
Use preceded $-signs to denote code blocks.
$ $ $(function() {
$ $ ndogen.run();
$ $ });
Topics
.................................................................
$ A Topic:
$
$ A subsequent paragraph,
$ with some text
Definitions
.................................................................
$ First definition: The value can be a paragraph
$ or any other element.
$
$ Second definition: * Item 1
$ * Item 2
Span Elements
-----------------------------------------------------------------
Links
.................................................................
Links are ready to be used inline. Links can be references to local
anchors or external resources.
$ An external Link[http://quasipartikel.at].
$ For more than one word as the link name you have to use quotes.
$ "See here"[http://github.com/oliver----/ndogen]
$
$ This is a references to a local anchor [SomeAnchor]
Emphasized text
.................................................................
$ _Single underscores_ or *single asterisks*
Strong text
.................................................................
$ _Double underscores_ or *double asterisks*
Inline Code
.................................................................
$ You can create an instance with `new Person()`