docs: strikethrough deprecated methods on api index (#2067)

Author: matthewmayer

docs/api/ApiIndex.vue

@@ -101,7 +101,11 @@ onUnmounted(() => window.removeEventListener('keydown', apiSearchFocusHandler));
           </h3>
           <ul>
             <li v-for="h of item.headers" :key="h.anchor">
-              <a :href="item.link + '#' + slugify(h.anchor)">{{ h.text }}</a>
+              <a
+                :href="item.link + '#' + slugify(h.anchor)"
+                :class="{ deprecated: h.deprecated }"
+                >{{ h.text }}</a
+              >
             </li>
           </ul>
         </div>
@@ -166,6 +170,10 @@ h3 {
   transition: color 0.5s;
 }
 
+.api-groups ul a.deprecated {
+  text-decoration: line-through;
+}
+
 .dark .api-groups ul a {
   font-weight: 400;
 }

docs/api/api-types.ts

@@ -6,6 +6,7 @@
 export interface APIHeader {
   anchor: string;
   text: string;
+  deprecated: boolean;
 }
 
 /**

scripts/apidoc/apiDocsWriter.ts

@@ -203,6 +203,7 @@ export function writeApiSearchIndex(pages: ModuleSummary[]): void {
         headers: module.methods.map((method) => ({
           anchor: method.name,
           text: method.name,
+          deprecated: !!method.deprecated,
         })),
       })),
     },