2025.03.8312

llms.txt

Writerside can now generate plain text files with the full contents of your documentation to feed as context for an LLM prompt. For information about the proposal to standardize this approach, see llmstxt.org.

Add the following to buildprofiles.xml to generate one file llms.txt and save it in the built artifact:

Set single-file="false" if you want to generate separate files for each topic and put them in the _llms directory.

Use <llms-txt/> without the single-file attribute to generate both the single file and the individual files.

For more information, see Generate llms.txt.

Multiple instance builds

You can now build multiple documentation instances as a single website using build groups. This feature is useful when you need to combine several related documentation instances into one cohesive documentation portal.

When building a group of instances, Writerside will:

• Create a separate directory for each instance in the output

• Add an index.html file that redirects to the first instance's home page

• Include a documentation switcher that allows users to navigate between instances

The CLI builder now has the --group option (use it instead of the --product option to specify a build group ID), and the Docker image accepts the IS_GROUP variable.

For more information, see Build groups.

API docs improvements

• Support for links

• Support for webhooks

• Support for pathItems as components

• Support for type arrays

• Support for multiple examples

• Support for securityDefinitions and securitySchemes

• Support for new authorization types: Mutual TLS (mTLS) and Digest

• Support for Markdown in descriptions of responses and objects.

• Move refactoring for OpenAPI spec files

New cards markup

Starting pages now have a new markup for cards that link to topics. Instead of <a>, you should now use the <card> element that has, among others, the following attributes:

• badge to specify one of the built-in badge icons

• icon to specify a custom icon for the card

• image to specify a custom image for the card

New social icons in footer

Use the type attribute of the <social> element in buildprofiles.xml to add an icon with a link to your blog, email, X or LinkedIn account. Writerside now supports the following additional values:

• slack

• discord

• stackoverflow

• telegram

• reddit

• mastodon

• github

• gitlab

• bug

• bitbucket

• wechat

• bluesky

• googleapp

• apple

• location

Also, the icon for twitter has been updated to X.

Other fixes and improvements

• Fixed issues with line breaks using <br/>, </br> and <br>

• Added a Refresh button to the Writerside Preview tool window

• Added an option to disable sync scroll in the Writerside Preview tool window options menu

• Variable completion now works in Markdown topics

• The topic navigation block with chapters, procedures, and other structural elements of a topic now has indentation to distinguish between header levels

• The ICP number in the footer now links to the Ministry of Industry and Information Technology to meet the requirements.

• The <notice> element was introduced to provide additional legal information, service notices, attributions, and acknowledgements in the footer.