Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔄 Redefine schema in terms of @types/mdast #67

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
4b0e828
wip
agoose77 Oct 21, 2024
0d244c6
wip: all types
agoose77 Oct 21, 2024
23dfd08
fix: more type fixes
agoose77 Oct 21, 2024
1442acc
feat: add schema output
agoose77 Oct 21, 2024
500e861
fix: add containers
agoose77 Oct 21, 2024
4396156
chore: drop build
agoose77 Oct 21, 2024
0534335
docs: remove mention of deviation
agoose77 Oct 21, 2024
2657958
chore: add lint
agoose77 Oct 21, 2024
7405799
docs: add docstrings
agoose77 Oct 21, 2024
c479954
chore: update workflow
agoose77 Oct 21, 2024
6b6c915
fix: make meta optional
agoose77 Oct 22, 2024
9661dd5
fix: correct node name
agoose77 Oct 22, 2024
0d16cfb
wip: tset-generation infra
agoose77 Oct 22, 2024
1a3b77e
fix: update examples to wrap bare text
agoose77 Oct 22, 2024
505f295
fix: make children and value required
agoose77 Oct 22, 2024
9e4a3e8
fix: more nodes should be opt-in association
agoose77 Oct 22, 2024
d0b1eee
fix: class for image and code
agoose77 Oct 22, 2024
2bde57c
fix: support Image.align
agoose77 Oct 22, 2024
3f26261
fix: support Image.width
agoose77 Oct 22, 2024
dbf116d
fix: use existing Table
agoose77 Oct 22, 2024
9b38f35
fix: table examples
agoose77 Oct 22, 2024
23ec2d3
fix: specify missing children
agoose77 Oct 22, 2024
4ffa33c
fix: only lint src
agoose77 Oct 22, 2024
815c0fd
feat!: drop schema output
agoose77 Oct 23, 2024
b6ea153
fix: use object type to fix schema generation
agoose77 Oct 23, 2024
583d289
Revert "feat!: drop schema output"
agoose77 Oct 23, 2024
a543efa
chore: restructure
agoose77 Oct 23, 2024
6798dbb
fix: use eslintrc
agoose77 Oct 24, 2024
f7cf8f1
feat: prepare for API docs
agoose77 Oct 24, 2024
9e5d525
feat: add AST generation
agoose77 Oct 24, 2024
b708a74
fix: embed spec in div
agoose77 Oct 24, 2024
65ad719
feat: work on examples
agoose77 Oct 25, 2024
bb4e4e8
fix: use commonmark in tsdoc comment
agoose77 Oct 25, 2024
8c6f82d
fix: example for mystTarget
agoose77 Oct 25, 2024
49f8c7f
feat: show array types as footnotes
agoose77 Oct 25, 2024
3f82f8f
fix: don't export Association mixin
agoose77 Oct 25, 2024
1a3d010
fix: add break case example
agoose77 Oct 25, 2024
a745126
feat: add up-to-date scripts
agoose77 Oct 25, 2024
ad5518e
fix: missing files
agoose77 Oct 25, 2024
a938508
fix: drop build step
agoose77 Oct 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: add break case example
  • Loading branch information
agoose77 committed Oct 25, 2024
commit 1a3d010193838c8c3284c7e8a1f80b5143629f9f
3 changes: 2 additions & 1 deletion docs/examples/commonmark.breaks.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
cases:
- title: CommonMark hard breaks
id: break
mdast:
type: root
children:
Expand All @@ -18,7 +19,7 @@ cases:
hard\\
break
- title: CommonMark thematic breaks
id: break
id: thematicBreak
mdast:
type: root
children:
Expand Down
1 change: 1 addition & 0 deletions docs/nodes.myst.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"kind":"Article","frontmatter":{"title":"MyST AST Index","content_includes_title":true},"mdast":{"type":"root","children":[{"type":"list","ordered":false,"spread":false,"children":[{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:abbreviation","children":[{"type":"inlineCode","value":"Abbreviation"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:admonition","children":[{"type":"inlineCode","value":"Admonition"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:admonitiontitle","children":[{"type":"inlineCode","value":"AdmonitionTitle"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:block","children":[{"type":"inlineCode","value":"Block"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:blockbreak","children":[{"type":"inlineCode","value":"BlockBreak"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:blockquote","children":[{"type":"inlineCode","value":"Blockquote"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:blockquotedata","children":[{"type":"inlineCode","value":"BlockquoteData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:break","children":[{"type":"inlineCode","value":"Break"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:breakdata","children":[{"type":"inlineCode","value":"BreakData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:caption","children":[{"type":"inlineCode","value":"Caption"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:code","children":[{"type":"inlineCode","value":"Code"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:codedata","children":[{"type":"inlineCode","value":"CodeData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:comment","children":[{"type":"inlineCode","value":"Comment"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:container","children":[{"type":"inlineCode","value":"Container"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:crossreference","children":[{"type":"inlineCode","value":"CrossReference"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:data","children":[{"type":"inlineCode","value":"Data"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:definition","children":[{"type":"inlineCode","value":"Definition"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:definitiondata","children":[{"type":"inlineCode","value":"DefinitionData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:delete","children":[{"type":"inlineCode","value":"Delete"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:deletedata","children":[{"type":"inlineCode","value":"DeleteData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:directive","children":[{"type":"inlineCode","value":"Directive"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:emphasis","children":[{"type":"inlineCode","value":"Emphasis"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:emphasisdata","children":[{"type":"inlineCode","value":"EmphasisData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:footnotedefinition","children":[{"type":"inlineCode","value":"FootnoteDefinition"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:footnotedefinitiondata","children":[{"type":"inlineCode","value":"FootnoteDefinitionData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:footnotereference","children":[{"type":"inlineCode","value":"FootnoteReference"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:footnotereferencedata","children":[{"type":"inlineCode","value":"FootnoteReferenceData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:heading","children":[{"type":"inlineCode","value":"Heading"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:headingdata","children":[{"type":"inlineCode","value":"HeadingData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:html","children":[{"type":"inlineCode","value":"Html"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:htmldata","children":[{"type":"inlineCode","value":"HtmlData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:image","children":[{"type":"inlineCode","value":"Image"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:imagedata","children":[{"type":"inlineCode","value":"ImageData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:imagereference","children":[{"type":"inlineCode","value":"ImageReference"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:imagereferencedata","children":[{"type":"inlineCode","value":"ImageReferenceData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:inlinecode","children":[{"type":"inlineCode","value":"InlineCode"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:inlinecodedata","children":[{"type":"inlineCode","value":"InlineCodeData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:inlinemath","children":[{"type":"inlineCode","value":"InlineMath"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:legend","children":[{"type":"inlineCode","value":"Legend"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:link","children":[{"type":"inlineCode","value":"Link"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:linkdata","children":[{"type":"inlineCode","value":"LinkData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:linkreference","children":[{"type":"inlineCode","value":"LinkReference"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:linkreferencedata","children":[{"type":"inlineCode","value":"LinkReferenceData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:list","children":[{"type":"inlineCode","value":"List"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:listdata","children":[{"type":"inlineCode","value":"ListData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:listitem","children":[{"type":"inlineCode","value":"ListItem"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:listitemdata","children":[{"type":"inlineCode","value":"ListItemData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:math","children":[{"type":"inlineCode","value":"Math"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:paragraph","children":[{"type":"inlineCode","value":"Paragraph"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:paragraphdata","children":[{"type":"inlineCode","value":"ParagraphData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:point","children":[{"type":"inlineCode","value":"Point"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:position","children":[{"type":"inlineCode","value":"Position"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:referencetype","children":[{"type":"inlineCode","value":"ReferenceType"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:role","children":[{"type":"inlineCode","value":"Role"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:root","children":[{"type":"inlineCode","value":"Root"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:rootdata","children":[{"type":"inlineCode","value":"RootData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:strong","children":[{"type":"inlineCode","value":"Strong"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:strongdata","children":[{"type":"inlineCode","value":"StrongData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:subscript","children":[{"type":"inlineCode","value":"Subscript"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:superscript","children":[{"type":"inlineCode","value":"Superscript"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:table","children":[{"type":"inlineCode","value":"Table"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:tablecell","children":[{"type":"inlineCode","value":"TableCell"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:tablecelldata","children":[{"type":"inlineCode","value":"TableCellData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:tabledata","children":[{"type":"inlineCode","value":"TableData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:tablerow","children":[{"type":"inlineCode","value":"TableRow"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:tablerowdata","children":[{"type":"inlineCode","value":"TableRowData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:target","children":[{"type":"inlineCode","value":"Target"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:text","children":[{"type":"inlineCode","value":"Text"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:textdata","children":[{"type":"inlineCode","value":"TextData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:thematicbreak","children":[{"type":"inlineCode","value":"ThematicBreak"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:thematicbreakdata","children":[{"type":"inlineCode","value":"ThematicBreakData"}]}]},{"type":"listItem","spread":true,"children":[{"type":"link","url":"#spec:underline","children":[{"type":"inlineCode","value":"Underline"}]}]}]}]}}