added in example description

2026-06-20 17:26:03 +08:00 · 2022-12-14 14:13:24 +00:00
parent f091fa666e
commit 8812985ec4
1 changed files with 10 additions and 0 deletions
--- a/apps/docs/components/reference/RefFunctionSection.tsx
+++ b/apps/docs/components/reference/RefFunctionSection.tsx
@@ -203,6 +203,16 @@ const RefFunctionSection: React.FC<IRefFunctionSection> = (props) => {
                                  .replace('js', '')
                                  .replace('ts', ''))}
                          </CodeBlock>
+
+                          {example.description && (
+                            <div className="bg-scale-300 prose px-4 py-2 rounded-md">
+                              <h5 className="text-sm m-0 text-scale-1100">Example Notes</h5>
+                              <ReactMarkdown className="text-sm">
+                                {example.description}
+                              </ReactMarkdown>
+                            </div>
+                          )}
+
                          {response && (
                            <RefDetailCollapse
                              id={`${example.id}-${exampleIndex}-response`}