Skip to content

Commit

Permalink
site: add FAQ entry for how to document a svelte component (#5131)
Browse files Browse the repository at this point in the history
  • Loading branch information
orta committed Jul 13, 2020
1 parent c2788de commit 8a8177b
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions site/content/faq/450-how-do-i-document-my-components.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 8a8177b

Please sign in to comment.