docs: docgen

This commit is contained in:
Folke Lemaitre 2025-02-16 09:23:15 +01:00
parent d036bf3399
commit d18680c931
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
6 changed files with 52 additions and 21 deletions

View file

@ -29,6 +29,17 @@ In order to automatically display the image when opening an image file,
or to have imaged displayed in supported document formats like `markdown` or `html`,
you need to enable the `image` plugin in your `snacks` config.
Supported document formats are:
- markdown
- html
- norg
- tsx
- javascript
- css
- vue
- angular
[ImageMagick](https://imagemagick.org/index.php) is required to convert images
to the supported formats (all except PNG).
@ -122,6 +133,12 @@ docs for more information on how to customize these styles
## 📚 Types
TODO:
- tsx / jsx
- url decode?
- look for all images?
```lua
---@alias snacks.image.Size {width: number, height: number}
---@alias snacks.image.Pos {[1]: number, [2]: number}