From 14911799b72c4d929a1f8b64d7d733dec00e1139 Mon Sep 17 00:00:00 2001 From: maddalax Date: Mon, 21 Oct 2024 10:21:52 -0500 Subject: [PATCH] add config docs --- .../md/docs/9_configuration/htmgo_config.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 htmgo-site/md/docs/9_configuration/htmgo_config.md diff --git a/htmgo-site/md/docs/9_configuration/htmgo_config.md b/htmgo-site/md/docs/9_configuration/htmgo_config.md new file mode 100644 index 0000000..6ba4b79 --- /dev/null +++ b/htmgo-site/md/docs/9_configuration/htmgo_config.md @@ -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: [] +```