<commit_before># 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
<commit_msg>Add some markup specs to the readme<commit_after># 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 "<NAME>", 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">
      <NAME>
    </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

{'fraction_non_alphanumeric': 0.07661520869068039, 'fraction_numerical': 0.010863350485991996, 'mean_word_length': 4.537974683544304, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3966872', 'n_tokens_mistral': 518, 'n_tokens_neox': 463, 'n_words': 242}