static

The static directory is copied directly into the public directory containing your finished web site.

If you want any static files to appear in your finished web site, simply put them in the static directory, and they will show up in the corresponding location in the public directory after your site is generated.

For example, this documentation site has a static/foo.jpg file. When the site is built, this file is copied into public/foo.jpg.

The static directory is where you want to put images, style sheets, JavaScript files, downloadable content, etc.

If a file is created dynamically by Uriel, but is also included in the static directory, the static version will end up overriding the dynamically-created version in the public directory when the site is generated. This can be useful if you need to override something like the generated robots.txt file.

If you want to link to static files from the web site, the most reliable way to do this is to use the {{static-url:foo.jpg}} substitution parameter. This parameter will reference the static files in a way that also verifies that the expected path exists at build time.

There is also a {{static-hash-url:foo.css}} parameter that works in a similar fashion, except that it copies the files to unique file names. This offers some additional benefits when working with CSS and JavaScript files.

Tags: robots-txt, static