Skip to content

Commit a540867

Browse files
authored
✍️ Remove old README docs about myst-spec (#2952)
* fix: remove old docs * chore: add changeset
1 parent b88d15d commit a540867

2 files changed

Lines changed: 5 additions & 34 deletions

File tree

.changeset/proud-items-smash.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'myst-spec': patch
3+
---
4+
5+
Remove old docs for myst-spec

packages/myst-spec/README.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -51,37 +51,3 @@ Markdown AST, or `mdast`, is an intermediate format that builds upon the existin
5151

5252
Beyond CommonMark and GitHub Flavoured Markdown, MyST introduces new directives and roles (like admonitions, citations, equations) following existing standards where they are defined. `mdast` is serializable to JSON or YAML, and can be effectively shared between projects, languages and implementations. The output of this repository is a versioned JSON file that can be used in implementations of MyST.
5353

54-
### Structure of the Repository
55-
56-
```
57-
schema/
58-
|- myst.schema.json // root schema definition
59-
|- myst.md // docs
60-
|- schema.spec.ts // test for validating all examples against the schema
61-
|- unist/
62-
| |- unist.schema.json // unist base types
63-
| |- unist.md // docs
64-
| |- unist.yml // example mdast structures
65-
|- commonmark/
66-
| |- commonmark.schema.json // commonmark mdast types
67-
| |- commonmark.md // docs
68-
| |- commonmark.yml // simple commonmark examples
69-
| |- cmark_spec_0.30.yml // commonmark spec examples
70-
...
71-
|- roles/ // future myst features
72-
| |- roles.schema.json
73-
| ...
74-
|- directives/
75-
| |- directives.schema.json
76-
| ...
77-
```
78-
79-
## Relation to other markup languages, frameworks
80-
81-
[TODO]
82-
83-
- CommonMark
84-
- GitHub Flavored Markdown
85-
- Pandoc
86-
- Unified
87-
- Markdown-It

0 commit comments

Comments
 (0)