Add a bit more to the configuration docs

This commit is contained in:
Michael Howell 2025-02-13 14:22:54 -07:00 committed by GitHub
parent 879449447f
commit 82db7f5b93
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -168,11 +168,12 @@ The following configuration options are available:
This string will be written to a file named CNAME in the root of your site, as This string will be written to a file named CNAME in the root of your site, as
required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages
site*][custom domain]). site*][custom domain]).
- **hash-files:** Include a cryptographic "fingerprint" of the files' contents in CSS, JavaScript, and image asset filenames, - **hash-files:** Include a cryptographic "fingerprint" of the files' contents in static asset filenames,
so that if the contents of the file are changed, the name of the file will also change. so that if the contents of the file are changed, the name of the file will also change.
For example, `css/chrome.css` may become `css/chrome-9b8f428e.css`. For example, `css/chrome.css` may become `css/chrome-9b8f428e.css`.
HTML files are not renamed. Chapter HTML files are not renamed.
Static CSS and JS files can reference each other using `{{ resource "filename" }}` directives. Static CSS and JS files can reference each other using `{{ resource "filename" }}` directives.
Defaults to `false` (in a future release, this may change to `true`).
[custom domain]: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site [custom domain]: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site