From 04e8b7bab82069bf60961580e353e36096bc2120 Mon Sep 17 00:00:00 2001
From: Shinigami <chrissi92@hotmail.de>
Date: Tue, 17 Jun 2025 21:30:05 +0200
Subject: docs: add remarks about external sources (#3452)

---
 docs/.vitepress/components/api-docs/method.ts  | 3 ++-
 docs/.vitepress/components/api-docs/method.vue | 6 ++++++
 2 files changed, 8 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/.vitepress/components/api-docs/method.ts b/docs/.vitepress/components/api-docs/method.ts
index 91f99d4e..9ae154ca 100644
--- a/docs/.vitepress/components/api-docs/method.ts
+++ b/docs/.vitepress/components/api-docs/method.ts
@@ -2,6 +2,7 @@ export interface ApiDocsMethod {
   readonly name: string;
   readonly deprecated: string | undefined; // HTML
   readonly description: string; // HTML
+  readonly remark: string | undefined; // HTML
   readonly since: string;
   readonly parameters: ApiDocsMethodParameter[];
   readonly returns: string;
@@ -9,7 +10,7 @@ export interface ApiDocsMethod {
   readonly signature: string; // HTML
   readonly examples: string; // HTML
   readonly refresh: (() => Promise<unknown[]>) | undefined;
-  readonly seeAlsos: string[];
+  readonly seeAlsos: string[]; // HTML
   readonly sourcePath: string; // URL-Suffix
 }
 
diff --git a/docs/.vitepress/components/api-docs/method.vue b/docs/.vitepress/components/api-docs/method.vue
index 37b44748..4ab876ca 100644
--- a/docs/.vitepress/components/api-docs/method.vue
+++ b/docs/.vitepress/components/api-docs/method.vue
@@ -11,6 +11,7 @@ const { method } = defineProps<{ method: ApiDocsMethod }>();
 const {
   deprecated,
   description,
+  remark,
   since,
   parameters,
   returns,
@@ -145,6 +146,11 @@ function seeAlsoToUrl(see: string): string {
 
     <div v-html="description"></div>
 
+    <div v-if="remark" class="tip custom-block">
+      <p class="custom-block-title">Note</p>
+      <div v-html="remark"></div>
+    </div>
+
     <p v-if="since">
       <em>Available since v{{ since }}</em>
     </p>
-- 
cgit v1.2.3