243.21565

Code samples

• Writerside now properly highlights all supported programming languages in code blocks in the output and suggests them in completion for the lang attribute.

• Reference files with code via relative paths. Previously, you had to register the code snippets directory and reference files from this directory. Now you can do this:

  <code-block lang="kotlin" src="../code/hello.kt"/>

  ```kotlin ``` { src="../code/hello.kt" }

• Navigate to source code files via Ctrl+Click.

• Writerside now correctly processes code blocks with empty lines.

For more information, see Code blocks.

API docs

• You can generate an API reference both as a new instance and as a new topic in an existing instance from the UI.

• Topics with generated API docs now also have a navigation sidebar, but it is collapsed by default.

• API docs are now searchable.

• Besides specifying the full path to the API specification file, you can now put the file in the designated specifications directory and reference the file directly as <api-doc openapi-path="spec.yaml"/>. You can also register a different directory for specifications in writerside.cfg, for example: <api-specifications dir="api-specs"/>.

For more information, see API documentation.

PDF export

• You can now produce PDF as a build artifact.

• You can now configure the "Table of Contents" title in the produced PDF.

• Fixed processing of table column widths, TOC titles, tooltip terms, and deflist sorting.

For more information, see Export to PDF.

Diagrams

• Upgraded to Mermaid version 11.0.2.

• You can now reference diagram files from the designated snippets directory or via a relative path to the file. For more information, see Reference code from file.

  <code-block lang="mermaid" src="graph.mermaid"/>

  ```mermaid ``` { src="graph.mermaid" }
  <code-block lang="mermaid" src="../diagrams/graph.mermaid"/>

  ```mermaid ``` { src="../diagrams/graph.mermaid" }

• Writerside no longer clips parts of text in multi-line Mermaid diagram nodes.

• Writerside no longer reports code blocks with diagrams as too wide.

Docker builder image

• The Docker image is now available in Docker Hub.

• You can now run the builder by passing environment variables to the container.

For more information, see Build with Docker.

The Good Docs Project templates

• When creating a new topic from The Good Docs Project, Writerside converts links to guides to absolute URLs.

Other fixes and improvements

• Writerside now supports borderless tables. See border attribute.

• There is now a dedicated Writerside section in the settings under Editor | General | Code Folding to disable auto-folding of various elements for XML topics.

  

• There is now a gutter icon to navigate from the currently open topic to the TOC element in the tree file.

  

  You can disable the gutter icon in the settings under Editor | General | Gutter Icons | Navigate from topic to TOC file.

• For XML topics, Writerside now shows the number of usages for elements with an ID. This way, you know how many times a snippet is reused (included somewhere else) or a chapter is referenced.

  

  You can disable the inlay hints with usages in the settings under Editor | Inlay Hints | Code Vision | Writerside element usages.

• Writerside no longer mentions ignored problems in the build report.

• Writerside now shows tooltips for links to social media resources.

• Writerside no longer produces MRK023 and MRK024 problems for missing <primary> and <secondary> blocks in a starting page topic (these elements are not mandatory).

• Writerside now properly produces the REF007 problem for redirects from an existing web file name.

• Writerside no longer produces false positive duplicate ID errors for admonitions and code blocks in Markdown topics.

• Writerside now properly generates canonicals for pages.

• Live preview no longer freezes after sleep mode.