Skip to content

Commit 257d7a4

Browse files
committed
Add note about recognized files
1 parent 83365af commit 257d7a4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/websites/website-tools.qmd

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,14 @@ An example script that is used for user tracking would look like:
359359

360360
Besides input and configuration files, your site likely also includes a variety of resources (e.g. images) that you will want to publish along with your site. Quarto will automatically detect any files that you reference within your site and copy them to the output directory (e.g. `_site`).
361361

362+
Quarto also recognizes the following files and copies them to your output directory:
363+
364+
* `404.html`, one option for providing a [404 Page](/docs/websites/website-navigation.qmd#pages-404)
365+
* `robots.txt`, a file specified by the [Robots Exclusion Protocol](https://datatracker.ietf.org/doc/html/rfc9309){.external} that tells search engine crawlers which pages or files on your website they can or cannot access
366+
* `_redirects`, a file used by some publishing providers to provide page redirects, e.g. [Netlify](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file){.external}
367+
* `CNAME`, a file used by some publishing providers to specify a custom domain, e.g. [GitHub Pages](/docs/publishing/github-pages.qmd#custom-domain)
368+
* `.nojekyll`, a file used by GitHub pages to bypass building with Jekyll, e.g. when [publishing from `docs/`](/docs/publishing/github-pages.qmd#render-to-docs)
369+
362370
If this auto-detection fails for any reason, or if you want to publish a file not explicitly linked to from within your site, you can add a `resources` entry to your configuration. For example, here we specify that we want to include all Excel spreadsheets within the project directory as part of the website:
363371

364372
``` {.yaml .yml}

0 commit comments

Comments
 (0)