https://github.com/wader/htmx-dash-docset
</> htmx dash docset
https://github.com/wader/htmx-dash-docset
dash-docset htmx
Last synced: 10 months ago
JSON representation
</> htmx dash docset
- Host: GitHub
- URL: https://github.com/wader/htmx-dash-docset
- Owner: wader
- Created: 2023-12-28T17:00:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T14:09:27.000Z (about 2 years ago)
- Last Synced: 2025-03-14T19:46:43.457Z (over 1 year ago)
- Topics: dash-docset, htmx
- Language: HTML
- Homepage:
- Size: 349 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# htmx dash docset
[Dash](https://kapeli.com/dash) docset for [htmx](https://htmx.org).
> [!WARNING]
> Very much work in progress.
### Install prebuilt docset
Add `htmx.docset` using the dash UI or open the docset to install (`open htmx.doset` on macOS).
### Build
```sh
docker build -t htmx-dash-docset . && \
docker run -v "$PWD:$PWD" -w "$PWD" htmx-dash-docset
```
Add `htmx.docset` to dash `open -a dash htmx.docset`
### Development
```sh
docker build -t htmx-dash-docset . && \
docker run -ti --entrypoint=sh -v "$PWD:$PWD" -w "$PWD" htmx-dash-docset
# in container do
./generate.sh
# to skip clone do
SKIP_CLONE=1 ./generate.sh
```
### TODO
- Some links seems wrong
- More strict `code` selector match
- Add logo
- Generate contrib `docset.json`
- Make sure no external resources are used
- Some script should be enabled?
- Add extensions, guides etc?
### Thanks and licenses
Documentation based on https://htmx.org/reference under BSD license https://github.com/bigskysoftware/htmx/blob/master/LICENSE
HTML generated using [zola](https://www.getzola.org).
Dash docset generated from HTML using [dashing](https://github.com/technosophos/dashing).