docs: proper page description

Author: giladgd

.vitepress/config.ts

@@ -16,6 +16,7 @@ import {Resvg, initWasm as initResvgWasm, type ResvgRenderOptions} from "@resvg/
 import {BlogPageInfoPlugin} from "./config/BlogPageInfoPlugin.js";
 import {getApiReferenceSidebar} from "./config/apiReferenceSidebar.js";
 import {ensureLocalImage} from "./utils/ensureLocalImage.js";
+import {getExcerptFromMarkdownFile} from "./utils/getExcerptFromMarkdownFile.js";
 import type {Element as HastElement, Parent} from "hast";
 
 import type {Node as UnistNode} from "unist";
@@ -28,6 +29,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const packageJson: typeof import("../package.json") = fs.readJsonSync(path.join(__dirname, "..", "package.json"));
 const env = envVar.from(process.env);
 
+const docsDir = path.join(__dirname, "..", "docs");
 const urlBase = env.get("DOCS_URL_BASE")
     .asString();
 const packageVersion = env.get("DOCS_PACKAGE_VERSION")
@@ -249,6 +251,27 @@ export default defineConfig({
             }
         }
 
+        if ((description == null || description === "") && pageData.filePath && !pageData.filePath.startsWith("api/")) {
+            const excerpt = await getExcerptFromMarkdownFile(await fs.readFile(path.join(docsDir, pageData.filePath), "utf8"));
+            if (excerpt != null && excerpt !== "")
+                description = excerpt.replaceAll('"', "'").replaceAll("\n", " ");
+        }
+
+        pageData.description = description;
+
+        if (description != null && description !== "" &&
+            (pageData.frontmatter.description == null || pageData.frontmatter.description === "")
+        ) {
+            pageData.frontmatter.description = description;
+            for (let i = 0; i < head.length; i++) {
+                const header = head[i]!;
+                if (header[0] === "meta" && header[1]?.name === "description") {
+                    head[i] = ["meta", {name: "description", content: description}];
+                    break;
+                }
+            }
+        }
+
         head.push(["meta", {name: "og:title", content: title}]);
         if (description != null && description !== "")
             head.push(["meta", {name: "og:description", content: description}]);
@@ -311,7 +334,7 @@ export default defineConfig({
         plugins: [
             GitChangelog({
                 repoURL: () => "https://github.com/withcatai/node-llama-cpp",
-                cwd: path.join(__dirname, "..", "docs")
+                cwd: docsDir
             }) as VitepressPlugin,
             GitChangelogMarkdownSection({
                 exclude: (id) => (
@@ -708,7 +731,7 @@ export default defineConfig({
             });
 
             for (const {url, excerpt, frontmatter, html} of blogPosts) {
-                const ogImageElement = findElementInHtml(html, (element) => element.tagName === "meta" && element.properties?.name === "og:imag");
+                const ogImageElement = findElementInHtml(html, (element) => element.tagName === "meta" && element.properties?.name === "og:image");
                 const date = new Date(frontmatter.date);
                 if (Number.isNaN(date.getTime()))
                     throw new Error(`Invalid date for blog post: ${url}`);

.vitepress/utils/getExcerptFromMarkdownFile.ts

@@ -0,0 +1,83 @@
+import {getMarkdownRenderer} from "./getMarkdownRenderer.js";
+
+export async function getExcerptFromMarkdownFile(
+    markdownContent: string,
+    removeTitle: boolean = true,
+    maxLength: number = 80
+) {
+    const renderer = await getMarkdownRenderer();
+    let content = markdownContent.trim().replaceAll("\r\n", "\n");
+
+    if (content.startsWith("---")) {
+        const frontMatterEndIndex = content.indexOf("\n---", "---".length);
+        const nextNewLine = content.indexOf("\n", frontMatterEndIndex + "\n---".length);
+        if (frontMatterEndIndex >= 0 && nextNewLine >= 0)
+            content = content.slice(nextNewLine + 1).trim();
+    }
+
+    if (removeTitle && content.startsWith("# ")) {
+        const nextNewLine = content.indexOf("\n");
+        if (nextNewLine >= 0)
+            content = content.slice(nextNewLine + "\n".length).trim();
+    }
+
+    const renderedText = markdownToPlainText(renderer, content).trim();
+
+    if (renderedText.length > maxLength) {
+        if (renderedText[maxLength] === " ")
+            return renderedText.slice(0, maxLength);
+
+        const lastSpaceIndex = renderedText.lastIndexOf(" ", maxLength);
+        if (lastSpaceIndex >= 0)
+            return renderedText.slice(0, lastSpaceIndex);
+
+        return renderedText.slice(0, maxLength);
+    }
+
+    return renderedText;
+}
+
+function markdownToPlainText(
+    markdownIt: Awaited<ReturnType<typeof getMarkdownRenderer>>,
+    markdown: string,
+    includeNotes: boolean = false,
+    includeCode: boolean = false
+) {
+    const env = {};
+    const pageTokens = markdownIt.parse(markdown, env);
+
+    function toText(tokens: typeof pageTokens) {
+        let text = "";
+        let addedParagraphSpace = false;
+
+        for (const token of tokens) {
+            if (!includeNotes && token.type === "inline" && token.level === 2)
+                continue;
+
+            if (token.children != null) {
+                const childrenText = toText(token.children);
+                if (addedParagraphSpace && childrenText.startsWith(" "))
+                    text += childrenText.slice(" ".length);
+                else
+                    text += childrenText;
+            } else if (
+                ["text", "code_block", "code_inline", "emoji"].includes(token.type) ||
+                (includeCode && ["fence"].includes(token.type))
+            ) {
+                if (addedParagraphSpace && token.content.startsWith(" "))
+                    text += token.content.slice(" ".length);
+                else
+                    text += token.content;
+
+                addedParagraphSpace = false;
+            } else if (token.type.endsWith("_close")) {
+                text += " ";
+                addedParagraphSpace = true;
+            }
+        }
+
+        return text;
+    }
+
+    return toText(pageTokens);
+}

docs/cli/chat.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'chat' command reference"
 ---
 # `chat` command
 

docs/cli/complete.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'complete' command reference"
 ---
 # `complete` command
 

docs/cli/index.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: CLI command reference
 ---
 # CLI
 

docs/cli/infill.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'infill' command reference"
 ---
 # `infill` command
 

docs/cli/init.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'init' command reference"
 ---
 # `init` command
 

docs/cli/inspect.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'inspect' command reference"
 ---
 # `inspect` command
 

docs/cli/inspect/estimate.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'inspect estimate' command reference"
 ---
 # `inspect estimate` command
 

docs/cli/inspect/gguf.md

@@ -1,5 +1,6 @@
 ---
 outline: deep
+description: "'inspect gguf' command reference"
 ---
 # `inspect gguf` command