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.
note
Starting pages are not supported for documentation published on the JetBrains Marketplace.
To create a new starting page topic, select the Section starting page template when creating a topic.
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.
Here is an example of a starting page topic markup:
Use the <spotlight> element to provide links for two of the most important topics. Set the type to define what icon the spotlight card should have.
Use the <primary> and <secondary> elements to provide links for other important and useful topics.
If necessary, use the <misc> element to provide links or cards to 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