add config docs

This commit is contained in:
maddalax 2024-10-21 10:21:52 -05:00
parent 635b17dd7f
commit 14911799b7

View file

@ -0,0 +1,26 @@
## Htmgo Configuration:
Certain aspects of htmgo can be configured via a `htmgo.yml` file in the root of your project.
Here is an example configuration file:
```yaml
# htmgo configuration
# if tailwindcss is enabled, htmgo will automatically compile your tailwind and output it to assets/dist
tailwind: true
# which directories to ignore when watching for changes, supports glob patterns through https://github.com/bmatcuk/doublestar
watch_ignore: [".git", "node_modules", "dist/*"]
# files to watch for changes, supports glob patterns through https://github.com/bmatcuk/doublestar
watch_files: ["**/*.go", "**/*.css", "**/*.md"]
# files or directories to ignore when automatically registering routes for pages
# supports glob patterns through https://github.com/bmatcuk/doublestar
automatic_page_routing_ignore: ["root.go"]
# files or directories to ignore when automatically registering routes for partials
# supports glob patterns through https://github.com/bmatcuk/doublestar
automatic_partial_routing_ignore: []
```