It is good for your readers and for SEO to provide an overview of you documentation and separate sections. These overviews group the most useful and popular topics or those dedicated to a specific subject. You can also use it to provide a learning path for readers: where to begin, which topics are generic and which are more advanced or cover some specific subsystem.
Starting pages are not supported for documentation published on the JetBrains Marketplace.
note
If the <section-starting-page> element is present in a topic, Writerside considers it a starting page topic and ignores all other content outside the starting page element.
For this reason, the starting page markup is not allowed in Markdown topics. Use only XML topics for starting pages. For more information, see Topic formats.
Use the <spotlight> element for two of the most important topics.
Use the <primary> and <secondary> elements for other important and useful topics.
If necessary, use the <misc> element for additional relevant topics.
Add groups of <links> and <cards>. For links, use the <group> element to split them into groups of links.
By default, additional miscellaneous groups are rendered in two columns. Add narrow="true" to a group if you want to render it in three narrow columns instead
For every <card>, you can add an icon, image, or badge:
Use the icon attribute to specify a custom image that will be rendered as a small icon on the card.
Use the image attribute to specify a custom image that will take up the whole top part of the card.
Use the badge attribute to specify one of the built-in badges included with Writerside.
