Skip to content

Commit 6cc451b

Browse files
authored
summarize docs (#1285)
1 parent e2d99ea commit 6cc451b

File tree

4 files changed

+22
-5
lines changed

4 files changed

+22
-5
lines changed

apps/svelte.dev/src/lib/server/content.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { read } from '$app/server';
2-
import type { Document } from '@sveltejs/site-kit';
2+
import type { Document, DocumentSummary } from '@sveltejs/site-kit';
33
import { create_index } from '@sveltejs/site-kit/server/content';
44

55
const documents = import.meta.glob<string>('../../../content/**/*.md', {
@@ -123,6 +123,14 @@ function create_docs() {
123123
return docs;
124124
}
125125

126+
export function create_summary(document: Document): DocumentSummary {
127+
return {
128+
slug: document.slug,
129+
metadata: document.metadata,
130+
children: document.children.map(create_summary)
131+
};
132+
}
133+
126134
export const docs = create_docs();
127135

128136
export const examples = index.examples.children;

apps/svelte.dev/src/routes/docs/[...path]/+layout.server.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { docs } from '$lib/server/content';
1+
import { create_summary, docs } from '$lib/server/content';
22
import { redirect } from '@sveltejs/kit';
33
import { error } from '@sveltejs/kit';
44

@@ -20,6 +20,6 @@ export async function load({ params }) {
2020
}
2121

2222
return {
23-
sections: document.children
23+
sections: document.children.map(create_summary)
2424
};
2525
}

packages/site-kit/src/lib/docs/DocsContents.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<script lang="ts">
22
import { afterNavigate } from '$app/navigation';
33
import { page } from '$app/stores';
4-
import type { Document } from '../types';
4+
import type { Document, DocumentSummary } from '../types';
55
66
interface Props {
7-
contents: Document[];
7+
contents: DocumentSummary[];
88
show_ts_toggle?: boolean;
99
}
1010

packages/site-kit/src/lib/types.d.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ export interface Document {
3232
prev: null | { slug: string; title: string };
3333
}
3434

35+
export interface DocumentSummary {
36+
slug: string;
37+
metadata: {
38+
title: string;
39+
[key: string]: any;
40+
};
41+
children: DocumentSummary[];
42+
}
43+
3544
export interface Section {
3645
slug: string;
3746
title: string;

0 commit comments

Comments
 (0)