Writerside Help

Allow search engine indexing

If you want your published documentation to be indexed by search engines, enable the Allow search engine indexing checkbox when creating a new instance. Otherwise, it will not be indexed by search engines and thus will not appear in search results.

Enable indexing for existing instance

  1. In the Writerside tool window, right-click an instance and select Edit.

  2. In the Edit Instance dialog, select Allow search engine indexing and click OK.

This option controls the <noindex-content> variable in buildprofiles.xml. By default, if the variable is not present, content will not be indexed. You can manually enable indexing by adding the variable globally for all instances or for a specific one:

<build-profile instance="foo"> <variables> <noindex-content>false</noindex-content> </variables> </build-profile>

Restrict indexing for topic

If you enable indexing globally or for certain published instances, you can still hide content of specific topics from search engines using the <no-index> tag.

  • Add a self-closing <no-index/> element at the beginning of a topic. You can filter this element to restrict indexing a topic only for specific instances.

    # Install Writerside <no-index instance="ab"/> This is how you install Writerside.
    <topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" title="Install Writerside" id="Installing_Writerside"> <no-index instance="ab"/> <p>This is how you install Writerside.</p> </topic>
Last modified: 08 January 2024