docs: fixed api-extractor version

marpple · Mar 20, 2024 · 5d94880 · 5d94880
1 parent f8825a7
commit 5d94880
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 7 deletions.
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -13,8 +13,8 @@ jobs:
         working-directory: website
         run: |
           npm ci
-          npm install -g @microsoft/api-extractor@7
-          npm install -g @microsoft/api-documenter@7
+          npm install -g @microsoft/api-extractor@7.20.0
+          npm install -g @microsoft/api-documenter@7.20.0
           make all
           npm run build
       - name: Deploy to GitHub Pages

diff --git a/website/README.md b/website/README.md
@@ -4,11 +4,11 @@
 
 - api-extractor
   ```
-  npm install -g @microsoft/api-extractor@7
+  npm install -g @microsoft/api-extractor@7.20.0
   ```
 - api-documenter
   ```
-  npm install -g @microsoft/api-documenter@7
+  npm install -g @microsoft/api-documenter@7.20.0
   ```
 
 ## Install / Update plugin markdown-plugin

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -11,7 +11,7 @@ const config = {
   tagline: "A functional library for TypeScript/JavaScript programmers.",
   url: "https://fxts.dev",
   baseUrl: "/",
-  onBrokenLinks: "ignore",
+  onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "ignore",
   favicon: "img/favicon.ico",
   i18n: {

diff --git a/website/markdown-plugin/src/MarkdownFeature.ts b/website/markdown-plugin/src/MarkdownFeature.ts
@@ -41,7 +41,12 @@ class MarkdownFeature extends MarkdownDocumenterFeature {
   public onBeforeWritePage(
     eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs,
   ): void {
-    this.header = ["---", `id: ${eventArgs.apiItem.displayName}`, "---"];
+    this.header = [
+      "---",
+      `id: ${eventArgs.apiItem.displayName}`,
+      "---",
+      "<!-- Do not edit this file. It is generated automatically -->",
+    ];
 
     this.footer = [];
 

diff --git a/website/tsdoc-metadata.json b/website/tsdoc-metadata.json
@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.20.0"
     }
   ]
 }