forked from denoland/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_config.ts
More file actions
344 lines (310 loc) · 10.1 KB
/
_config.ts
File metadata and controls
344 lines (310 loc) · 10.1 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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
import "@std/dotenv/load";
import lume from "lume/mod.ts";
import esbuild from "lume/plugins/esbuild.ts";
import jsx from "lume/plugins/jsx.ts";
import mdx from "lume/plugins/mdx.ts";
import ogImages from "lume/plugins/og_images.ts";
import redirects from "lume/plugins/redirects.ts";
import search from "lume/plugins/search.ts";
import sitemap from "lume/plugins/sitemap.ts";
import tailwind from "lume/plugins/tailwindcss.ts";
import Prism from "./prism.ts";
import title from "https://deno.land/x/lume_markdown_plugins@v0.7.0/title.ts";
import toc from "https://deno.land/x/lume_markdown_plugins@v0.7.0/toc.ts";
// See note below about GFM CSS
// import { CSS as GFM_CSS } from "https://jsr.io/@deno/gfm/0.11.0/style.ts";
import { log } from "lume/core/utils/log.ts";
import anchor from "npm:markdown-it-anchor@9";
import admonitionPlugin from "./markdown-it/admonition.ts";
import codeblockCopyPlugin from "./markdown-it/codeblock-copy.ts";
import codeblockTitlePlugin from "./markdown-it/codeblock-title.ts";
import relativeLinksPlugin from "./markdown-it/relative-path.ts";
import replacerPlugin from "./markdown-it/replacer.ts";
import apiDocumentContentTypeMiddleware from "./middleware/apiDocContentType.ts";
import createRoutingMiddleware from "./middleware/functionRoutes.ts";
import createGAMiddleware from "./middleware/googleAnalytics.ts";
import redirectsMiddleware from "./middleware/redirects.ts";
import { toFileAndInMemory } from "./utils/redirects.ts";
import { cliNow } from "./timeUtils.ts";
// Check if reference docs are available when building
function ensureReferenceDocsExist() {
const requiredFiles = [
"reference_gen/gen/deno.json",
"reference_gen/gen/web.json",
"reference_gen/gen/node.json",
];
const missingFiles = [];
for (const file of requiredFiles) {
try {
Deno.statSync(file);
} catch {
missingFiles.push(file);
}
}
if (missingFiles.length > 0) {
console.error(
`❌ Missing reference documentation files: ${missingFiles.join(", ")}`,
);
console.error(
` Run 'deno task generate:reference' to generate them before building`,
);
console.error(` Or set SKIP_REFERENCE=1 to skip reference documentation`);
Deno.exit(1);
}
}
// Ensure reference docs exist at startup for full builds
if (Deno.env.get("BUILD_TYPE") === "FULL" && !Deno.env.has("SKIP_REFERENCE")) {
ensureReferenceDocsExist();
}
const site = lume(
{
location: new URL("https://docs.deno.com"),
caseSensitiveUrls: true,
emptyDest: false,
server: {
middlewares: [
redirectsMiddleware,
createRoutingMiddleware(),
createGAMiddleware({
addr: { transport: "tcp", hostname: "localhost", port: 3000 },
}),
apiDocumentContentTypeMiddleware,
],
page404: "/404/",
},
watcher: {
ignore: ["/.git", "/.github", "/.vscode"],
debounce: 1_000,
},
},
{
markdown: {
plugins: [
replacerPlugin,
admonitionPlugin,
codeblockCopyPlugin,
codeblockTitlePlugin,
[
anchor,
{
permalink: anchor.permalink.linkInsideHeader({
symbol:
`<span class="sr-only">Jump to heading</span><span aria-hidden="true" class="anchor-end">#</span>`,
placement: "after",
}),
getTokensText(tokens: { type: string; content: string }[]) {
return tokens
.filter((t) => ["text", "code_inline"].includes(t.type))
.map((t) => t.content.replaceAll(/ \([0-9/]+?\)/g, ""))
.join("")
.trim();
},
},
],
relativeLinksPlugin,
],
options: {
linkify: true,
langPrefix: "highlight notranslate language-",
highlight: (code, lang) => {
if (!lang || !Prism.languages[lang]) {
return code;
}
const result = Prism.highlight(code, Prism.languages[lang], lang);
return result || code;
},
},
},
},
);
// ignore some folders that have their own build tasks
// site.ignore("styleguide");
site.copy("static", ".");
site.copy("timeUtils.ts");
site.copy("subhosting/api/images");
site.copy("deploy/docs-images");
site.copy("deploy/images");
site.copy("deploy/classic/images");
site.copy("deploy/kv/images");
site.copy("deploy/tutorials/images");
site.copy("sandboxes/images");
site.copy("runtime/fundamentals/images");
site.copy("runtime/getting_started/images");
site.copy("runtime/reference/images");
site.copy("runtime/contributing/images");
site.copy("examples/tutorials/images");
site.copy("deploy/manual/images");
site.copy("deploy/images");
site.copy("examples/scripts");
site.use(
redirects({
output: toFileAndInMemory,
}),
);
site.use(search());
site.use(jsx());
site.use(mdx());
site.add("js");
site.use(
esbuild({
extensions: [".ts"],
options: {
minify: false,
splitting: true,
alias: {
"node:crypto": "./_node-crypto.js",
},
},
}),
);
site.add("style.css");
site.use(tailwind({
minify: true,
}));
site.use(toc({ anchor: false }));
site.use(title());
site.use(sitemap());
site.addEventListener("afterBuild", async () => {
// Write GFM CSS
/* NOTE: we used to get gfm.css from the jsr.io CDN, but now we simply have a local copy. This is because it needs to be placed on a CSS layer, which isn't possible with an imported file. */
// Deno.writeTextFileSync(site.dest("gfm.css"), GFM_CSS);
// Generate LLMs documentation files directly to _site directory
if (Deno.env.get("BUILD_TYPE") == "FULL") {
try {
const { default: generateModule } = await import(
"./generate_llms_files.ts"
);
const { collectFiles, generateLlmsTxt, generateLlmsFullTxt } =
generateModule;
log.info("Generating LLM-friendly documentation files...");
const files = await collectFiles();
log.info(`Collected ${files.length} documentation files for LLMs`);
// Generate llms.txt
const llmsTxt = generateLlmsTxt(files);
Deno.writeTextFileSync(site.dest("llms.txt"), llmsTxt);
log.info("Generated llms.txt in site root");
// Generate llms-full.txt
const llmsFullTxt = generateLlmsFullTxt(files);
Deno.writeTextFileSync(site.dest("llms-full.txt"), llmsFullTxt);
log.info("Generated llms-full.txt in site root");
} catch (error) {
log.error("Error generating LLMs files:" + error);
}
}
});
site.copy("reference_gen/gen/deno/page.css", "/api/deno/page.css");
site.copy("reference_gen/gen/deno/styles.css", "/api/deno/styles.css");
site.copy("reference_gen/gen/deno/script.js", "/api/deno/script.js");
site.copy("reference_gen/gen/web/page.css", "/api/web/page.css");
site.copy("reference_gen/gen/web/styles.css", "/api/web/styles.css");
site.copy("reference_gen/gen/web/script.js", "/api/web/script.js");
site.copy("reference_gen/gen/node/page.css", "/api/node/page.css");
site.copy("reference_gen/gen/node/styles.css", "/api/node/styles.css");
site.copy("reference_gen/gen/node/script.js", "/api/node/script.js");
site.ignore(
"old",
"README.md",
(path) => path.match(/\/reference_gen.*.ts/) !== null,
(path) => path.includes("/reference_gen/node_modules"),
(path) => path.includes("/reference_gen/node_descriptions"),
(path) => path.includes("/lint/rules/"),
// "deploy",
// "runtime",
// "subhosting",
// "404",
);
// the default layout if no other layout is specified
site.data("layout", "doc.tsx");
// Load API categories data globally
import denoCategories from "./reference_gen/deno-categories.json" with {
type: "json",
};
import webCategories from "./reference_gen/web-categories.json" with {
type: "json",
};
import nodeRewriteMap from "./reference_gen/node-rewrite-map.json" with {
type: "json",
};
const nodeCategories = Object.keys(nodeRewriteMap);
site.data("apiCategories", {
deno: {
title: "Deno APIs",
categories: Object.keys(denoCategories),
descriptions: denoCategories,
getCategoryHref: (categoryName: string) => {
// Special case for I/O -> io
if (categoryName === "I/O") {
return `/api/deno/io`;
}
return `/api/deno/${categoryName.toLowerCase().replace(/\s+/g, "-")}`;
},
},
web: {
title: "Web APIs",
categories: Object.keys(webCategories),
descriptions: webCategories,
getCategoryHref: (categoryName: string) => {
// Special case for I/O -> io
if (categoryName === "I/O") {
return `/api/web/io`;
}
return `/api/web/${categoryName.toLowerCase().replace(/\s+/g, "-")}`;
},
},
node: {
title: "Node APIs",
categories: nodeCategories,
descriptions: {} as Record<string, string>,
getCategoryHref: (categoryName: string) => `/api/node/${categoryName}/`,
},
});
// Do more expensive operations if we're building the full site
if (Deno.env.get("BUILD_TYPE") == "FULL") {
// Use Lume's built in date function to get the last modified date of the file
// site.data("date", "Git Last Modified");;
// Generate Open Graph images
site.data("openGraphLayout", "/open_graph/default.jsx");
site.use(
ogImages({
options: {
width: 1200,
height: 630,
fonts: [
{
name: "Courier",
style: "normal",
data: (await Deno.readFile(
"./static/fonts/courier/CourierPrime-Regular.ttf",
)).buffer,
},
{
name: "Inter",
weight: 400,
style: "normal",
data: (await Deno.readFile(
"./static/fonts/inter/hacked/Inter-Regular-hacked.woff",
)).buffer,
},
{
name: "Inter",
weight: 700,
style: "normal",
data: (await Deno.readFile(
"./static/fonts/inter/hacked/Inter-SemiBold-hacked.woff",
)).buffer,
},
],
},
}),
);
}
site.scopedUpdates(
(path) => /\.(js|ts)$/.test(path),
(path) => path.startsWith("/api/deno/"),
);
site.addEventListener("afterStartServer", () => {
log.warn(
`${cliNow()} Server available at <green>http://localhost:3000</green>`,
);
});
export default site;