Node.js Modules: Terminology: Contribution

1 - Contribution.md

Terminology: Contribution

Definitions are authored in reStructuredText as it offers the necessary shorthand syntax and supports a fair subset of common Markdown syntaxes which minimizes both conversion and learning burdens for contributors.

2 - References.md

References

• http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections
• https://gist.github.com/dupuy/1855764
• https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
• https://seikichi.github.io/restructured/

3- Syntax.md

Syntax

Definition Lists

Definition List

Term 1

Definition paragraph 1.

Definition paragraph 2.

Term 2

Definition paragraph 1.

Definition paragraph 2.

Github Flavoured Markdown (GFM) (and other mainstream flavours) do not have a commonly accepted syntax for definition list elements, including <dl> Definition List, <lh> List Header, <dt> Definition Term, or <dd> Definition.

It naturally follows that for our specific goals, it would be counter productive to use raw html for in most major features of the documents, which is where RST comes in.

Markdown

<dl> 
<lh> Definition List
<dt>  Term 1
<dd> 
<p>  Definition paragraph 1.
<p>  Definition paragraph 2.
<dt>  Term 2
<dd> 
<p>  Definition paragraph 1.
<p>  Definition paragraph 2.

reStructuredText

Definition Lists
----------------

Term 1
  Definition paragraph 1.

  Definition paragraph 2.

Term 2
  Definition paragraph 1.

  Definition paragraph 2.

4- Structure.rst

HTML H1

# Heading 1

Normal paragraph

* Heading 2

Normal paragraph.

= Heading 3

Normal paragraph.

- Heading 4

Normal paragraph.

^ Heading 5

Normal paragraph.

" Heading 6 """"""""""""""

Normal paragraph.

---

There is kind of a +1 thing going on here compared to markdown

Interleaves

Heading 2

Normal paragraph.

Heading 3

Normal paragraph.

Heading 2

Normal paragraph.

HTML H1

Sample.rst

Definition Lists

Term

Definition

Term

Definition paragraph 1.

Definition paragraph 2.

---

Code

A block of code

python.code('hooray')

export function f(a, b, c) {
  return 'awesome';
}

---

Raw

Markdown

HTML

HTML Heading 1

---