From 8a8177b89739dc97aa7e1e5377c3ba2dbc72ddb0 Mon Sep 17 00:00:00 2001
From: Orta Therox <orta.therox@gmail.com>
Date: Mon, 13 Jul 2020 11:46:24 -0400
Subject: [PATCH] site: add FAQ entry for how to document a svelte component
 (#5131)

---
 .../450-how-do-i-document-my-components.md    | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 site/content/faq/450-how-do-i-document-my-components.md

diff --git a/site/content/faq/450-how-do-i-document-my-components.md b/site/content/faq/450-how-do-i-document-my-components.md
new file mode 100644
index 000000000000..78177abd5498
--- /dev/null
+++ b/site/content/faq/450-how-do-i-document-my-components.md
@@ -0,0 +1,32 @@
+---
+question: How do I document my components?
+---
+
+In editors which use the Svelte Language Server you can document Components, functions and exports using specially formatted comments.
+
+````svelte
+<script>
+	/** What should we call the user? */
+	export let name = 'world';
+</script>
+
+<!--
+@component
+Here's some documentation for this component.
+It will show up on hover.
+
+- You can use markdown here.
+- You can also use code blocks here.
+- Usage:
+  ```tsx
+  <main name="Arethra">
+  ```
+-->
+<main>
+	<h1>
+		Hello, {name}
+	</h1>
+</main>
+````
+
+Note: The `@component` is necessary in the HTML comment which describes your component.