Skip to content

Commit 0c1b33e

Browse files
committed
Refactor docs to replace emphasis with code in readme.md
1 parent ef2d055 commit 0c1b33e

File tree

1 file changed

+82
-49
lines changed

1 file changed

+82
-49
lines changed

readme.md

+82-49
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ re-created.
2323

2424
### `Root`
2525

26-
**Root** ([**Parent**][parent]) houses all nodes.
26+
`Root` ([`Parent`][parent]) houses all nodes.
2727

2828
```idl
2929
interface Root <: Parent {
@@ -33,7 +33,7 @@ interface Root <: Parent {
3333

3434
### `Paragraph`
3535

36-
**Paragraph** ([**Parent**][parent]) represents a unit of discourse dealing
36+
`Paragraph` ([`Parent`][parent]) represents a unit of discourse dealing
3737
with a particular point or idea.
3838

3939
```idl
@@ -62,7 +62,7 @@ Yields:
6262

6363
### `Blockquote`
6464

65-
**Blockquote** ([**Parent**][parent]) represents a quote.
65+
`Blockquote` ([`Parent`][parent]) represents a quote.
6666

6767
```idl
6868
interface Blockquote <: Parent {
@@ -93,7 +93,7 @@ Yields:
9393

9494
### `Heading`
9595

96-
**Heading** ([**Parent**][parent]), just like with HTML, with a level greater
96+
`Heading` ([`Parent`][parent]), just like with HTML, with a level greater
9797
than or equal to 1, lower than or equal to 6.
9898

9999
```idl
@@ -124,9 +124,10 @@ Yields:
124124

125125
### `Code`
126126

127-
**Code** ([**Text**][text]) occurs at block level (see **InlineCode** for
128-
code spans). **Code** sports a language tag (when using GitHub Flavoured
129-
Markdown fences with a flag, `null` otherwise).
127+
`Code` ([`Text`][text]) occurs at block level (see
128+
[`InlineCode`][inlinecode] for code spans). `Code` sports a language
129+
tag (when using GitHub Flavoured Markdown fences with a flag, `null`
130+
otherwise).
130131

131132
```idl
132133
interface Code <: Text {
@@ -153,8 +154,8 @@ Yields:
153154

154155
### `InlineCode`
155156

156-
**InlineCode** ([**Text**][text]) occurs inline (see **Code** for blocks).
157-
Inline code does not sport a `lang` attribute.
157+
`InlineCode` ([`Text`][text]) occurs inline (see [`Code`][code] for
158+
blocks). Inline code does not sport a `lang` attribute.
158159

159160
```idl
160161
interface InlineCode <: Text {
@@ -179,7 +180,7 @@ Yields:
179180

180181
### `YAML`
181182

182-
**YAML** ([**Text**][text]) can occur at the start of a document, and
183+
`YAML` ([`Text`][text]) can occur at the start of a document, and
183184
contains embedded YAML data.
184185

185186
```idl
@@ -207,7 +208,7 @@ Yields:
207208

208209
### `HTML`
209210

210-
**HTML** ([**Text**][text]) contains embedded HTML.
211+
`HTML` ([`Text`][text]) contains embedded HTML.
211212

212213
```idl
213214
interface HTML <: Text {
@@ -232,7 +233,7 @@ Yields:
232233

233234
### `List`
234235

235-
**List** ([**Parent**][parent]) contains **ListItem**’s.
236+
`List` ([`Parent`][parent]) contains [`ListItem`s][listitem].
236237

237238
The `start` property contains the starting number of the list when
238239
`ordered: true`; `null` otherwise.
@@ -243,9 +244,9 @@ When all list items have `loose: false`, the list’s `loose` property is also
243244
```idl
244245
interface List <: Parent {
245246
type: "list";
246-
loose: true | false;
247-
start: uint32 | null;
248247
ordered: true | false;
248+
start: uint32 | null;
249+
loose: true | false;
249250
}
250251
```
251252

@@ -280,11 +281,11 @@ Yields:
280281

281282
### `ListItem`
282283

283-
**ListItem** ([**Parent**][parent]) is a child of a **List**.
284+
`ListItem` ([`Parent`][parent]) is a child of a [`List`][list].
284285

285-
Loose **ListItem**s often contain more than one block-level elements.
286+
Loose `ListItem`s often contain more than one block-level elements.
286287

287-
When in `gfm: true` mode, a checked property exists on **ListItem**s,
288+
When in `gfm: true` mode, a checked property exists on `ListItem`s,
288289
either set to `true` (when checked), `false` (when unchecked), or `null`
289290
(when not containing a checkbox). See [Task Lists on GitHub][task-list]
290291
for information.
@@ -297,13 +298,13 @@ interface ListItem <: Parent {
297298
}
298299
```
299300

300-
For an example, see the definition of **List**.
301+
For an example, see the definition of [`List`][list].
301302

302303
### `Table`
303304

304-
**Table** ([**Parent**][parent]) represents tabular data, with alignment.
305-
Its children are either **TableHeader** (the first child), or **TableRow**
306-
(all other children).
305+
`Table` ([`Parent`][parent]) represents tabular data, with alignment.
306+
Its children are either [`TableHeader`][tableheader] (the first child),
307+
or [`TableRow`][tablerow] (all other children).
307308

308309
`table.align` represents the alignment of columns.
309310

@@ -379,43 +380,45 @@ Yields:
379380

380381
### `TableHeader`
381382

382-
**TableHeader** ([**Parent**][parent]). Its children are always **TableCell**.
383+
`TableHeader` ([`Parent`][parent]). Its children are always
384+
[`TableCell`][tablecell].
383385

384386
```idl
385387
interface TableHeader <: Parent {
386388
type: "tableHeader";
387389
}
388390
```
389391

390-
For an example, see the definition of **Table**.
392+
For an example, see the definition of [`Table`][table].
391393

392394
### `TableRow`
393395

394-
**TableRow** ([**Parent**][parent]). Its children are always **TableCell**.
396+
`TableRow` ([`Parent`][parent]). Its children are always
397+
[`TableCell`][tablecell].
395398

396399
```idl
397400
interface TableRow <: Parent {
398401
type: "tableRow";
399402
}
400403
```
401404

402-
For an example, see the definition of **Table**.
405+
For an example, see the definition of `Table`.
403406

404407
### `TableCell`
405408

406-
**TableCell** ([**Parent**][parent]). Contains a single tabular field.
409+
`TableCell` ([`Parent`][parent]). Contains a single tabular field.
407410

408411
```idl
409412
interface TableCell <: Parent {
410413
type: "tableCell";
411414
}
412415
```
413416

414-
For an example, see the definition of **Table**.
417+
For an example, see the definition of [`Table`][table].
415418

416419
### `ThematicBreak`
417420

418-
A **ThematicBreak** ([**Node**][node]) represents a break in content,
421+
A `ThematicBreak` ([`Node`][node]) represents a break in content,
419422
often shown as a horizontal rule, or by two HTML section elements.
420423

421424
```idl
@@ -440,7 +443,7 @@ Yields:
440443

441444
### `Break`
442445

443-
**Break** ([**Node**][node]) represents an explicit line break.
446+
`Break` ([`Node`][node]) represents an explicit line break.
444447

445448
```idl
446449
interface Break <: Node {
@@ -478,7 +481,7 @@ Yields:
478481

479482
### `Emphasis`
480483

481-
**Emphasis** ([**Parent**][parent]) represents slightly important text.
484+
`Emphasis` ([`Parent`][parent]) represents slightly important text.
482485

483486
```idl
484487
interface Emphasis <: Parent {
@@ -522,7 +525,7 @@ Yields:
522525

523526
### `Strong`
524527

525-
**Strong** ([**Parent**][parent]) represents super important text.
528+
`Strong` ([`Parent`][parent]) represents super important text.
526529

527530
```idl
528531
interface Strong <: Parent {
@@ -566,7 +569,7 @@ Yields:
566569

567570
### `Delete`
568571

569-
**Delete** ([**Parent**][parent]) represents text ready for removal.
572+
`Delete` ([`Parent`][parent]) represents text ready for removal.
570573

571574
```idl
572575
interface Delete <: Parent {
@@ -594,7 +597,7 @@ Yields:
594597

595598
### `Link`
596599

597-
**Link** ([**Parent**][parent]) represents the humble hyperlink.
600+
`Link` ([`Parent`][parent]) represents the humble hyperlink.
598601

599602
```idl
600603
interface Link <: Parent {
@@ -626,7 +629,7 @@ Yields:
626629

627630
### `Image`
628631

629-
**Image** ([**Node**][node]) represents the figurative figure.
632+
`Image` ([`Node`][node]) represents the figurative figure.
630633

631634
```idl
632635
interface Image <: Node {
@@ -656,7 +659,7 @@ Yields:
656659

657660
### `Footnote`
658661

659-
**Footnote** ([**Parent**][parent]) represents an inline marker, whose
662+
`Footnote` ([`Parent`][parent]) represents an inline marker, whose
660663
content relates to the document but is outside its flow.
661664

662665
```idl
@@ -685,9 +688,9 @@ Yields:
685688

686689
### `LinkReference`
687690

688-
**LinkReference** ([**Parent**][parent]) represents a humble hyperlink,
691+
`LinkReference` ([`Parent`][parent]) represents a humble hyperlink,
689692
its `href` and `title` defined somewhere else in the document by a
690-
**Definition**.
693+
[`Definition`][definition].
691694

692695
`referenceType` is needed to detect if a reference was meant as a
693696
reference (`[foo][]`) or just unescaped brackets (`[foo]`).
@@ -728,13 +731,13 @@ Yields:
728731

729732
### `ImageReference`
730733

731-
**ImageReference** ([**Node**][node]) represents a figurative figure,
734+
`ImageReference` ([`Node`][node]) represents a figurative figure,
732735
its `src` and `title` defined somewhere else in the document by a
733-
**Definition**.
736+
[`Definition`][definition].
734737

735738
`referenceType` is needed to detect if a reference was meant as a
736739
reference (`![foo][]`) or just unescaped brackets (`![foo]`).
737-
See **LinkReference** for the definition of `referenceType`.
740+
See [`LinkReference`][linkreference] for the definition of `referenceType`.
738741

739742
```idl
740743
interface ImageReference <: Node {
@@ -764,9 +767,9 @@ Yields:
764767

765768
### `FootnoteReference`
766769

767-
**FootnoteReference** ([**Node**][node]) is like **Footnote**, but its
768-
content is already outside the documents flow: placed in a
769-
**FootnoteDefinition**.
770+
`FootnoteReference` ([`Node`][node]) is like [`Footnote`][footnote],
771+
but its content is already outside the documents flow: placed in a
772+
[`FootnoteDefinition`][footnotedefinition].
770773

771774
```idl
772775
interface FootnoteReference <: Node {
@@ -792,8 +795,9 @@ Yields:
792795

793796
### `Definition`
794797

795-
**Definition** ([**Node**][node]) represents the definition (i.e., location
796-
and title) of a **LinkReference** or an **ImageReference**.
798+
`Definition` ([`Node`][node]) represents the definition (i.e., location
799+
and title) of a [`LinkReference`][linkreference] or an
800+
[`ImageReference`][imagereference].
797801

798802
```idl
799803
interface Definition <: Node {
@@ -823,8 +827,8 @@ Yields:
823827

824828
### `FootnoteDefinition`
825829

826-
**FootnoteDefinition** ([**Parent**][parent]) represents the definition
827-
(i.e., content) of a **FootnoteReference**.
830+
`FootnoteDefinition` ([`Parent`][parent]) represents the definition
831+
(i.e., content) of a [`FootnoteReference`][footnotereference].
828832

829833
```idl
830834
interface FootnoteDefinition <: Parent {
@@ -857,8 +861,9 @@ Yields:
857861

858862
### `TextNode`
859863

860-
**TextNode** ([**Text**][text]) represents everything that is just text.
861-
Note that its `type` property is `text`, but it is different from **Text**.
864+
`TextNode` ([`Text`][text]) represents everything that is just text.
865+
Note that its `type` property is `text`, but it is different from
866+
[`Text`][text].
862867

863868
```idl
864869
interface TextNode <: Text {
@@ -913,3 +918,31 @@ MIT © [Titus Wormer](http://wooorm.com)
913918
[migrate]: https://github.com/wooorm/remark/releases/tag/3.0.0
914919

915920
[task-list]: https://help.github.com/articles/writing-on-github/#task-lists
921+
922+
[inlinecode]: #inlinecode
923+
924+
[code]: #code
925+
926+
[list]: #list
927+
928+
[listitem]: #listitem
929+
930+
[table]: #table
931+
932+
[tableheader]: #tableheader
933+
934+
[tablerow]: #tablerow
935+
936+
[tablecell]: #tablecell
937+
938+
[definition]: #definition
939+
940+
[linkreference]: #linkreference
941+
942+
[imagereference]: #imagereference
943+
944+
[footnote]: #footnote
945+
946+
[footnotereference]: #footnotereference
947+
948+
[footnotedefinition]: #footnotedefinition

0 commit comments

Comments
 (0)