Skip to content

Commit

Permalink
docs: add eslint config (#41)
Browse files Browse the repository at this point in the history
Otherwise there are errors about missing `>` when opening a composition file.
  • Loading branch information
enyo committed Apr 30, 2024
1 parent 3f5aac9 commit f92f49d
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion packages/kitbook/src/docs/4-component-compositions.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@ And add this VSCode setting:
}
```

And if you are using eslint:

```js twoslash title=".eslintrc.cjs" {6}
module.exports = {
overrides: [
{
files: [
'*.svelte',
'*.composition'
]
// ...
}
]
}
```

You can also create a Composition beside a corresponding markdown documentation page as you see in [[complex-examples]] (look at the source code) - just click the `Add Composition` button when viewing your markdown page.

Now that you have a composition in place, learn how to [[5-write-documentation|document your components]], including sprinkling in compositions where helpful.
Expand All @@ -36,4 +52,4 @@ Now that you have a composition in place, learn how to [[5-write-documentation|d
[SearchResult]: ../lib/layout/sidebar/search/SearchResult.md "SearchResult"
[complex-examples]: 2-compositions/complex-examples.md "Advanced Composition Use Cases"
[5-write-documentation|document your components]: 5-write-documentation.md "Write Documentation"
[//end]: # "Autogenerated link references"
[//end]: # "Autogenerated link references"

0 comments on commit f92f49d

Please sign in to comment.