UNPKG

myst-spec/dist/examples/references.headings.yml

Version:

1cases:
- title: Default header reference
  mdast:
    type: root
    children:
      - type: paragraph
        children:
          - type: text
            value: 'See: '
          - type: mystRole
            name: ref
            value: my_id
            children:
              - type: crossReference
                kind: ref
                identifier: my_id
                label: my_id
      - type: mystTarget
        label: my_id
      - type: heading
        depth: 1
        children:
          - type: strong
            children:
              - type: text
                value: My
          - type: text
            value: ' Header'
  myst: |-
    See: {ref}`my_id`
31
    (my_id)=
    # **My** Header
  html: |-
    <p>See: <a href="#my_id"><strong>My</strong> Header</a></p>
    <h1 id="my_id"><strong>My</strong> Header</h1>
- title: Custom header reference
  mdast:
    type: root
    children:
      - type: paragraph
        children:
          - type: text
            value: 'See: '
          - type: mystRole
            name: ref
            value: something... <my_id>
            children:
              - type: crossReference
                kind: ref
                identifier: my_id
                label: my_id
                children:
                  - type: text
                    value: something...
      - type: mystTarget
        label: my_id
      - type: heading
        depth: 1
        children:
          - type: text
            value: My Header
  myst: |-
    See: {ref}`something... <my_id>`
65
    (my_id)=
    # My Header
  html: |-
    <p>See: <a href="#my_id">something...</a></p>
    <h1 id="my_id">My Header</h1>
- title: Link-style default header reference
  mdast:
    type: root
    children:
      - type: paragraph
        children:
          - type: text
            value: 'See: '
          - type: link
            url: my_id
            children: []
      - type: mystTarget
        label: my_id
      - type: heading
        depth: 1
        children:
          - type: strong
            children:
              - type: text
                value: My
          - type: text
            value: ' Header'
  myst: |-
    See: [](my_id)
95
    (my_id)=
    # **My** Header
  html: |-
    <p>See: <a href="#my_id"><strong>My</strong> Header</a></p>
    <h1 id="my_id"><strong>My</strong> Header</h1>
- title: Link-style custom header reference
  mdast:
    type: root
    children:
      - type: paragraph
        children:
          - type: text
            value: 'See: '
          - type: link
            url: My_Id
            title: Title
            children:
              - type: text
                value: something...
      - type: mystTarget
        label: my_id
      - type: heading
        depth: 1
        children:
          - type: text
            value: My Header
  myst: |-
    See: [something...](My_Id "Title")
124
    (my_id)=
    # My Header
  html: |-
    <p>See: <a href="#my_id" title="Title">something...</a></p>
    <h1 id="my_id">My Header</h1>

1	`cases:`
2	`- title: Default header reference`
3	`mdast:`
4	`type: root`
5	`children:`
6	`- type: paragraph`
7	`children:`
8	`- type: text`
9	`value: 'See: '`
10	`- type: mystRole`
11	`name: ref`
12	`value: my_id`
13	`children:`
14	`- type: crossReference`
15	`kind: ref`
16	`identifier: my_id`
17	`label: my_id`
18	`- type: mystTarget`
19	`label: my_id`
20	`- type: heading`
21	`depth: 1`
22	`children:`
23	`- type: strong`
24	`children:`
25	`- type: text`
26	`value: My`
27	`- type: text`
28	`value: ' Header'`
29	`myst: \|-`
30	See: {ref}`my_id`
31
32	`(my_id)=`
33	`# My Header`
34	`html: \|-`
35	`<p>See: <a href="#my_id"><strong>My</strong> Header</a></p>`
36	`<h1 id="my_id"><strong>My</strong> Header</h1>`
37	`- title: Custom header reference`
38	`mdast:`
39	`type: root`
40	`children:`
41	`- type: paragraph`
42	`children:`
43	`- type: text`
44	`value: 'See: '`
45	`- type: mystRole`
46	`name: ref`
47	`value: something... <my_id>`
48	`children:`
49	`- type: crossReference`
50	`kind: ref`
51	`identifier: my_id`
52	`label: my_id`
53	`children:`
54	`- type: text`
55	`value: something...`
56	`- type: mystTarget`
57	`label: my_id`
58	`- type: heading`
59	`depth: 1`
60	`children:`
61	`- type: text`
62	`value: My Header`
63	`myst: \|-`
64	See: {ref}`something... <my_id>`
65
66	`(my_id)=`
67	`# My Header`
68	`html: \|-`
69	`<p>See: <a href="#my_id">something...</a></p>`
70	`<h1 id="my_id">My Header</h1>`
71	`- title: Link-style default header reference`
72	`mdast:`
73	`type: root`
74	`children:`
75	`- type: paragraph`
76	`children:`
77	`- type: text`
78	`value: 'See: '`
79	`- type: link`
80	`url: my_id`
81	`children: []`
82	`- type: mystTarget`
83	`label: my_id`
84	`- type: heading`
85	`depth: 1`
86	`children:`
87	`- type: strong`
88	`children:`
89	`- type: text`
90	`value: My`
91	`- type: text`
92	`value: ' Header'`
93	`myst: \|-`
94	`See: [](my_id)`
95
96	`(my_id)=`
97	`# My Header`
98	`html: \|-`
99	`<p>See: <a href="#my_id"><strong>My</strong> Header</a></p>`
100	`<h1 id="my_id"><strong>My</strong> Header</h1>`
101	`- title: Link-style custom header reference`
102	`mdast:`
103	`type: root`
104	`children:`
105	`- type: paragraph`
106	`children:`
107	`- type: text`
108	`value: 'See: '`
109	`- type: link`
110	`url: My_Id`
111	`title: Title`
112	`children:`
113	`- type: text`
114	`value: something...`
115	`- type: mystTarget`
116	`label: my_id`
117	`- type: heading`
118	`depth: 1`
119	`children:`
120	`- type: text`
121	`value: My Header`
122	`myst: \|-`
123	`See: [something...](My_Id "Title")`
124
125	`(my_id)=`
126	`# My Header`
127	`html: \|-`
128	`<p>See: <a href="#my_id" title="Title">something...</a></p>`
129	`<h1 id="my_id">My Header</h1>`