aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2023-04-21 01:44:26 +0700
committerGitHub <[email protected]>2023-04-20 20:44:26 +0200
commitbf67a219365d63c9430d4935056752859eaeaa8f (patch)
tree5d1a635e038016e56c319a008b51ffc474537654 /docs
parenta001ac5cf284d3027b9726f1f1f5f3fa14bc7bf4 (diff)
downloadfaker-bf67a219365d63c9430d4935056752859eaeaa8f.tar.xz
faker-bf67a219365d63c9430d4935056752859eaeaa8f.zip
docs: strikethrough deprecated methods on api index (#2067)
Diffstat (limited to 'docs')
-rw-r--r--docs/api/ApiIndex.vue10
-rw-r--r--docs/api/api-types.ts1
2 files changed, 10 insertions, 1 deletions
diff --git a/docs/api/ApiIndex.vue b/docs/api/ApiIndex.vue
index 53e89c49..608385b4 100644
--- a/docs/api/ApiIndex.vue
+++ b/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;
}
diff --git a/docs/api/api-types.ts b/docs/api/api-types.ts
index f5dcd659..d8678f9d 100644
--- a/docs/api/api-types.ts
+++ b/docs/api/api-types.ts
@@ -6,6 +6,7 @@
export interface APIHeader {
anchor: string;
text: string;
+ deprecated: boolean;
}
/**