# Editors' Notes markup language
This is parser for a custom flavor of [CommonMark] that
includes extensions for authoring scholarly notes on [Editors' Notes]. The
following additions are supported, based off of conventions in [Pandoc] and
[MultiMarkdown].

# Features
The Editors' Notes markup language supports the syntax of [CommonMark], with
several additions

## Inline references to Editors' Notes entitites

## Fenced blocks of references to Editors' Notes entities

## Footnotes

## Citations

# Testing
  * `npm install`
  * `npm test`

[CommonMark]: http://commonmark.org/
[Editors' Notes]: http://editorsnotes.org/
[Pandoc]: http://pandoc.org/
[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

# Editors' Notes markup language
This is parser for a custom flavor of [CommonMark] that
includes extensions for authoring scholarly notes on [Editors' Notes]. The
following additions are supported, based off of conventions in [Pandoc] and
[MultiMarkdown].

# Features
The Editors' Notes markup language supports the syntax of [CommonMark], with
several additions

## Inline references to Editors' Notes entitites
References to topics and notes can be added within text with the syntax

  `@@t(TOPIC_ID)`

and

  `@@n(NOTE_ID)`

respectively. For example, if topic 140 in a project with the slug `p` had the
name "Woodrow Wilson", the markup

  `In a contentious election, @@t140 was elected president in 1912.`

would result in the html:

```
  <p>
    In a contentions election, 
    <a href="/projects/p/topics/140/" rel="topic">
      Woodrow Wilson
    </a>
    was elected president in 1912.
  </p>
```

## Link references to Editors' Notes entities
Links to topics, documents, and notes can also be added to arbitrary text by
including the `@@` syntax as link href values. For example, `[some text](@@d1)`
would include a link to the document with ID 1.

## Fenced blocks for extended commentary on documents

## Footnotes

## Citations

# Testing
  * `npm install`
  * `npm test`

[CommonMark]: http://commonmark.org/
[Editors' Notes]: http://editorsnotes.org/
[Pandoc]: http://pandoc.org/
[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

Add some markup specs to the readme
Add some markup specs to the readme
