Repository navigation
Expand file tree
/
Copy pathconfig.ts
More file actions
169 lines (167 loc) · 5.22 KB
/
Copy pathconfig.ts
File metadata and controls
169 lines (167 loc) · 5.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
import { Config, nodes, Tag, ValidationError, Node } from '@markdoc/markdoc';
import slugify from '@sindresorhus/slugify';
export const markdocConfig: Config = {
tags: {
emoji: {
render: 'Emoji',
selfClosing: true,
attributes: {
symbol: { type: String, required: true },
alt: { type: String, required: true },
},
},
'coming-soon': {
render: 'ComingSoon',
selfClosing: true,
},
details: {
render: 'details',
children: nodes.document.children,
},
summary: {
render: 'summary',
children: nodes.document.children,
},
sup: {
render: 'sup',
children: nodes.strong.children,
},
hint: {
children: ['paragraph'],
attributes: {
kind: { type: String, required: true, matches: ['warn', 'tip', 'error'] },
},
transform(node, config) {
const children = node.transformChildren(config);
const attributes = node.transformAttributes(config);
return children.map(child => {
if (child instanceof Tag) {
return new Tag(
child.name,
{
...child.attributes,
className: `${
child.attributes.className ? `${child.attributes.className} ` : ''
}hint ${attributes.kind}`,
},
child.children
);
}
return child;
});
},
},
'related-content': {
render: 'RelatedContent',
children: ['tag'],
},
well: {
render: 'Well',
children: ['paragraph'],
attributes: {
heading: { type: String },
href: { type: String },
target: { type: String, matches: ['_blank'] },
},
},
},
nodes: {
document: {
...nodes.document,
validate(node) {
const errors: ValidationError[] = [];
// we want good stable ids so we require documentation authors write ids
// when they could be ambiguous rather than just adding an index
const seenHeadings = new Map<string, Node | 'reported'>();
for (const child of node.children) {
if (child.type === 'heading') {
const id = getIdForHeading(child);
// we report an error for this in the heading validation
if (id.length === 0) {
continue;
}
const existingHeading = seenHeadings.get(id);
if (!existingHeading) {
seenHeadings.set(id, child);
continue;
}
const ambiguousHeadingError = (node: Node): ValidationError => ({
id: 'ambiguous-heading-id',
level: 'error',
message: `The id for this heading is "${id}" which is the same as another heading in this file, disambiguate them with {% #some-id-here %} after a heading`,
location: node.location,
});
if (existingHeading !== 'reported') {
errors.push(ambiguousHeadingError(existingHeading));
seenHeadings.set(id, 'reported');
}
errors.push(ambiguousHeadingError(child));
}
}
return errors;
},
},
fence: {
render: 'CodeBlock',
attributes: {
content: { type: String, render: false, required: true },
language: { type: String, default: 'typescript' },
// process determines whether or not markdoc processes tags inside the content of the code block
process: { type: Boolean, render: false, default: false },
},
},
heading: {
render: 'Heading',
attributes: {
level: { type: Number, required: true },
id: { type: String },
},
validate(node) {
const errors: ValidationError[] = [];
if (node.attributes.level === 1) {
errors.push({
message:
"H1's are not allowed, specify the title in frontmatter at the top of the file if you're trying to specify the page title, otherwise use a different heading level",
id: 'no-h1',
level: 'error',
});
}
const id = getIdForHeading(node);
if (id.length === 0) {
errors.push({
id: 'empty-id',
level: 'error',
message:
'This heading has an empty id, change the heading content so that a non-empty id is generated or add {% #some-id %} after the heading',
});
}
return errors;
},
transform(node, config) {
const attributes = node.transformAttributes(config);
const children = node.transformChildren(config);
return new Tag(this.render, { ...attributes, id: getIdForHeading(node) }, children);
},
},
image: {
...nodes.image,
attributes: {
...nodes.image.attributes,
width: { type: String },
height: { type: String },
},
},
},
};
function getIdForHeading(node: Node): string {
if (typeof node.attributes.id === 'string') {
return node.attributes.id;
}
let stringified = '';
for (const child of node.walk()) {
if (child.type === 'text' || child.type === 'code') {
stringified += child.attributes.content;
}
}
return slugify(stringified);
}