llms.txt: machine-readable documentation index. Markdown version of this page is also available.

Writerside Help

Downloadable resources

You can bundle files with the published help website and add links for downloading them from relevant topics. For example, you can add a ZIP archive with a project template, or a CSV or TXT file with some sample data for a tutorial.

Add downloadable files to topic

  1. Put the files that you want readers to be able to download in the resources directory.

  2. Add a link to a file using the <resource> element with the specified resource identifier:

    Download <resource src="sample-resource.txt"/> and open it.

When you build your help instance, the resource files are stored in the resources directory. Writerside generates download links to the corresponding resource files:

Download sample-resource.txt and open it.

11 May 2024