### Complete Footer Configuration Example
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/customize-the-look.html
Demonstrates a comprehensive footer setup including copyright, ICP, multiple social links, and various external resource links.
```xml
Product 2000-2023
123456789
```
--------------------------------
### Basic writerside.cfg Example
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-cfg.html
A simple configuration file defining directories for topics and images, and two help instances.
```xml
```
--------------------------------
### XML Topic File Example
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/topics.html
Illustrates the basic structure of an XML topic file in Writerside.
```xml
getting-started.topic
{...}
```
--------------------------------
### Run Sample Search Service
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
Download and run the `writerside-search-1.0.jar` to start a sample search service. This command initiates the service without any search indexes, allowing for basic testing.
```bash
java -jar writerside-search-1.0.jar run
```
--------------------------------
### Configure Footer in buildprofiles.xml
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/customize-the-look.html
Use the `` element in `buildprofiles.xml` to define copyright, social links, and other resources. This example shows a basic configuration.
```xml
2000 JetBrains s.r.o.
```
--------------------------------
### Run http-server for Local Deployment
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html
After unpacking the generated ZIP archive, use this command to start a local HTTP server in the directory containing the help website. This allows you to preview the deployed site on localhost.
```bash
http-server ~/my-help
```
--------------------------------
### Sample buildprofiles.xml Configuration
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
This is a comprehensive example of a buildprofiles.xml file, demonstrating the structure and common elements used for configuring build profiles, variables, shortcuts, and footer content.
```xml
https://www.jetbrains.com/help
https://www.jetbrains.com/writerside/download/
Get Writerside
true
strawberry
writerside.svg
https://www.jetbrains.com/icon-512.png
keymap.xml
Writerside Blog
Writerside on Twitter
2000 JetBrains s.r.o.
false
https://www.jetbrains.com/help/writerside/
@onwriterside
https://resources.jetbrains.com/storage/products/writerside/img/meta/preview.png
https://my.company.com/images/
```
--------------------------------
### Example Search Query URL
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
The help application sends search requests to the configured URL with parameters like `query`, `isExactSearch`, and `maxHits`. The endpoint should be mapped to `/preview-search/{1}/{2}`.
```url
https://my.search/endpoint/preview-search/my-docs/hi?isExactSearch=false&maxHits=25&query=hello
```
--------------------------------
### Example Search Service URL and Configuration
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
In the built artifacts, the `config.json` file will contain `searchService` and `searchServiceUrl` keys. The `searchServiceUrl` is constructed using the configured endpoint, project root, and help instance ID.
```json
searchService: "custom"
searchServiceUrl: "https://my.search/endpoint/preview-search/my-docs/hi"
```
--------------------------------
### Environment file for Docker builder
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-with-docker.html
Example content for a builder.env file, specifying environment variables for the Writerside Docker build process.
```env
SOURCE_DIR=/opt/sources
MODULE_INSTANCE=Writerside/hi
OUTPUT_DIR=/opt/sources/output
RUNNER=other
PDF=PDF.xml
```
--------------------------------
### Group Topics with a TOC Element in Writerside
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/table-of-contents.html
Wrap existing TOC elements within a new parent `` to create a group or section. This example demonstrates grouping 'Installation.md' and 'Configuration.md' under a 'Getting started' section.
```xml
```
--------------------------------
### Markdown Topic File Example
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/topics.html
Illustrates the basic structure of a Markdown topic file in Writerside.
```markdown
getting-started.md
{...}
```
--------------------------------
### Footer with Copyright and Social Links
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/customize-the-look.html
Example of a footer configuration including copyright notice and two social media links.
```xml
```
--------------------------------
### Workflow to Build Documentation to PDF
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/deploy-docs-to-github-pages.html
This example shows a separate GitHub Actions workflow with a `build-pdf` job to produce a PDF artifact. Ensure the `PDF.xml` file is present in the `cfg` directory.
```yaml
name: Build to PDF
{...}
```
--------------------------------
### Example Generated OpenAPI Reference
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-api-reference.html
An example of an OpenAPI reference generated by Writerside, showing a single endpoint with its details.
```APIDOC
## Create a new document
/documents
### Request parameters
JSON example
```
{
"title": "Example Document",
"content": "This is some example content for the document."
}
```
### Responses
201
400
```
{
"message": "Document created"
}
```
```
{
"message": "Bad Request"
}
```
```
--------------------------------
### Set Download Button Title
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Defines the text for the header download button. Defaults to 'Get %instance%', where %instance% is the current product name.
```xml
Download Now
```
--------------------------------
### Create Git Graph with Mermaid
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/mermaid-diagrams.html
Visualize Git branching workflows for external contributors or team newcomers. This example demonstrates a simple branching and merging process.
```mermaid
gitGraph
commit
commit
branch DOC-123-update-the-doc-A
checkout DOC-123-update-the-doc-A
commit id: "write the procedure"
commit id: "update screenshots"
checkout main
merge DOC-123-update-the-doc-A
commit
commit
```
--------------------------------
### Configure Header Download Button
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/customize-the-look.html
Add a button to the header that links to a download location or external website. The `` URL and `` flag are required. The `` is optional and defaults to 'Get %instance%' if not provided.
```xml
Get Awesome App
```
```xml
https://example.com
```
```xml
true
```
--------------------------------
### Reference Response Sample from File
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-a-single-api-endpoint-reference.html
Provide response samples from an external file using the `src` attribute on the `` element. Use `include-lines` to specify a range or comma-separated list of lines from the source file to include in the example.
```xml
```
--------------------------------
### Create State Diagram with Mermaid
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/mermaid-diagrams.html
Use state diagrams to illustrate system behavior changes based on inputs or user actions. This example shows a basic state flow from 'Draft' to 'Ready to publish'.
```mermaid
stateDiagram-v2
[*] --> Draft
RR: Ready for review
NU: Need updates
AC: Apply changes
LGTM: All good
RP: Ready to publish
Draft --> RR
RR --> Review
Review --> NU
NU --> AC
AC --> Review
Review --> LGTM
LGTM --> RP
RP --> [*]
```
--------------------------------
### Run Search Service on a Custom Port
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
Start the search service on a port other than the default 8080 by using the `server.port` system property. This is useful if port 8080 is already in use.
```bash
java -Dserver.port=1234 -jar writerside-search-1.0.jar run
```
--------------------------------
### Run Search Service with Algolia Indexes
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
Specify the path to the directory containing Algolia indexes when starting the search service. Ensure Algolia indexes are unpacked from the Docker build output.
```bash
java -jar writerside-search-1.0.jar run --algolia-indexes=/path/to/algolia-indexes-HI/
```
--------------------------------
### Example Document JSON Request Body
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-api-reference.html
This JSON structure represents a sample request body for creating a new document, including a title and content.
```json
{
"title": "Example Document",
"content": "This is some example content for the document."
}
```
--------------------------------
### Provide Custom Request Samples
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-a-single-api-endpoint-reference.html
Override default request samples by adding a `` element inside ``. Use `` elements to provide examples in different languages like JSON and JavaScript.
```xml
{
"id": 123,
"name": "John Doe",
"email": "john.doe@example.com"
}
const data = {
id: 123,
name: "John Doe",
email: "john.doe@example.com"
};
```
--------------------------------
### Pull Writerside Docker builder image from JetBrains Docker Registry
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-with-docker.html
Use this command to pull the latest writerside-builder image from the JetBrains Docker Registry. Ensure Docker is installed and configured.
```bash
docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:2026.04.8711
```
--------------------------------
### Create Help Instance Artifact with Command Line
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-on-teamcity.html
This script uses TeamCity's command line build step to inspect and build the help instance. It sets up a virtual display, runs the Writerside builder, and verifies the artifact's existence. Ensure the `INSTANCE` and `ARTIFACT` environment variables are correctly set.
```bash
set -e
export DISPLAY=:99
Xvfb $DISPLAY &
sleep 1
/opt/builder/bin/idea.sh helpbuilderinspect -source-dir . -product $INSTANCE -output-dir artifacts/
echo "Test existing of $ARTIFACT artifact"
test -e artifacts/$ARTIFACT
echo "$ARTIFACT exists"
```
--------------------------------
### Build documentation website workflow
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/deploy-docs-to-github-pages.html
This workflow triggers on push to the main branch, builds the starter project, and saves the generated website archive as a 'docs' artifact. Ensure environment variables like INSTANCE and DOCKER_VERSION are correctly set.
```yaml
name: Build documentation
on:
push:
branches: [ main ]
env:
INSTANCE: "Writerside/hi"
DOCKER_VERSION: "2026.04.8711"
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Build documentation website
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
docker_version: ${{ env.DOCKER_VERSION }}
- name: Upload documentation artifact
uses: actions/upload-artifact@v4
with:
name: docs
path: build/docs/hi
```
--------------------------------
### GET /users/{id}
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-a-single-api-endpoint-reference.html
This endpoint retrieves user information by ID. It supports custom response samples for different status codes.
```APIDOC
## GET /users/{id}
### Description
Retrieves user information by a specified ID. This endpoint allows for custom response samples to be defined for various HTTP status codes.
### Method
GET
### Endpoint
/users/{id}
### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the user.
- **name** (string) - The name of the user.
- **email** (string) - The email address of the user.
#### Response Example (200)
```json
{
"id": 123,
"name": "John Doe",
"email": "john.doe@example.com"
}
```
#### Error Response (400)
- **error** (string) - A message describing the error.
#### Response Example (400)
```json
{
"error": "text"
}
```
```
--------------------------------
### Configure Help Instance Settings
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-cfg.html
Define a help instance with its source, web path, and version. This is used to specify how a particular help set is presented on the website.
```xml
` tags. This example shows a main topic with two subtopics.
```xml
```
--------------------------------
### Basic .gitlab-ci.yml for GitLab Pages deployment
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/deploy-docs-to-gitlab-pages.html
This sample pipeline triggers on pushes to the `main` branch. It builds, tests, and publishes documentation from the starter project to GitLab Pages.
```yaml
.gitlab-ci.yml
{...}
```
--------------------------------
### Pull Writerside Builder Image
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/2026.04.8711.html
Use this command to pull the Writerside builder Docker image for version 2026.04.8711. Ensure Docker is installed and running.
```bash
docker pull jetbrains/writerside-builder:2026.04.8711
```
--------------------------------
### Hello, World! in Java
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html
A basic Java program to print 'Hello, World!'.
```java
class MyClass {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
--------------------------------
### Dockerfile for Building Help Website
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-with-docker.html
A Dockerfile that uses the Writerside builder image to build a help website and then serves it using an Apache HTTP server. It includes build arguments for customization.
```dockerfile
FROM jetbrains/writerside-builder:2026.04.8711 as build
ARG INSTANCE=Writerside/hi
RUN mkdir /opt/sources
WORKDIR /opt/sources
ADD Writerside ./Writerside
RUN export DISPLAY=:99 && \
Xvfb :99 & \
/opt/builder/bin/idea.sh helpbuilderinspect --source-dir /opt/sources --product $INSTANCE --runner other --output-dir /opt/wrs-output/
WORKDIR /opt/wrs-output
RUN unzip -O UTF-8 webHelpHI2-all.zip -d /opt/wrs-output/unzipped-artifact
FROM httpd:2.4 as http-server
COPY --from=build /opt/wrs-output/unzipped-artifact/ /usr/local/apache2/htdocs/
```
--------------------------------
### Embed D2 Diagram Code
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/d2-diagrams.html
Use a code block with the language set to 'd2' to embed D2 diagrams directly. Ensure D2 is installed separately.
```d2
direction: right
question: Do you write docs?
yes: Use Writerside
no: You should
question -> yes: Yes
question -> no: No
```
```d2
direction: right
question: Do you write docs?
yes: Use Writerside
no: You should
question -> yes: Yes
question -> no: No
```
--------------------------------
### Use Global Variables in Markdown
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/variables.html
Embed global variables directly into Markdown content. The variable will be interpolated when the documentation is rendered. This example shows a note styled with a blockquote.
```markdown
> We recommend switching to the version %latest_version%.
>
{style="note"}
```
--------------------------------
### Sample Search Service Output (No Index)
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
When running the sample search service without an index, the console output will indicate the created controller and empty index paths. A request to the service will return zero hits.
```text
Created controller with engine TFIDF
algoliaIndexPath =
tfidfIndexPath =
```
```json
{"nbHits":0,"queryID":"e6e726f8-ebce-4296-ad9c-de8ee4bd3543","hits":[]}
```
--------------------------------
### Extract Help Instance Artifact with Command Line
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-on-teamcity.html
This script uses a Python module to unzip the generated artifact into the specified directory. It's used as a subsequent build step after the artifact has been created.
```bash
ls -lR
mkdir -p helproot/img/
echo "Unzip artifact to shared folder"
python3 -m zipfile -e artifacts/$ARTIFACT helproot/
```
--------------------------------
### Add a Simple Mermaid Graph
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/mermaid-diagrams.html
Insert a code block with the language set to 'mermaid' to create a simple graph. Ensure the Mermaid plugin is installed for full editor assistance.
```mermaid
graph LR
A[Do you write docs?]
A -- Yes --> B[Use Writerside]
A -- No --> C[Tell us why]
```
--------------------------------
### Run Docker Container with Direct Options
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-with-docker.html
Execute the helpbuilderinspect command directly within a Docker container, providing options as command-line arguments. Ensure DISPLAY and Xvfb are set up within the same RUN directive.
```bash
docker run --rm -v .:/opt/sources \
jetbrains/writerside-builder:2026.04.8711 \
/bin/bash -c "
export DISPLAY=:99 &&
Xvfb :99 &
/opt/builder/bin/idea.sh helpbuilderinspect \
--source-dir /opt/sources \
--product Writerside/hi \
--output-dir /opt/sources/output \
--runner other \
-pdf PDF.xml \
"
```
--------------------------------
### Configure Version Switcher
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Specify the link to the help-versions.json file that lists all published versions of your documentation. The help website uses this file to render the version switcher component.
```xml
https://my.documentation.com/help-versions.json
```
--------------------------------
### Configure Layouts for Keymap Displays
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Define different keymap layouts for your help website, specifying both the internal name and the display name for the shortcuts switcher.
```xml
set PATH=c:\\;%PATH%
```
--------------------------------
### GitHub Actions Workflow for Deployment
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/deploy-docs-to-github-pages.html
This workflow automates the build, test, and deployment of documentation to GitHub Pages. It requires write permissions for `id-token` and `pages` scopes.
```yaml
build-docs.yml
{...}
```
--------------------------------
### Implement Topic-Level Switcher with XML
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/tabs.html
Use the `` element with a `switcher-label` attribute and mark chapters or sections with `switcher-key` to create a single switcher for the entire topic. This allows content to be shown or hidden based on the selected key.
```xml
...
Some Java examples.
Some Kotlin examples.
...
```
--------------------------------
### Define Custom API Response Samples
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-a-single-api-endpoint-reference.html
Use `` with a `type` attribute to specify the HTTP status code and `` to provide the JSON response body. This allows for custom examples for success (e.g., 200) and error (e.g., 400) scenarios.
```xml
{
"id": 123,
"name": "John Doe",
"email": "john.doe@example.com"
}
{
"error": "text"
}
```
--------------------------------
### Define Glossary Terms
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/tooltips.html
Create a `glossary.xml` file to define terms and their descriptions. This file is essential for linking tooltips to specific terms.
```xml
Graphical User Interface
Hypertext Transfer Protocol
```
--------------------------------
### Configure Snippet Directory
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/code.html
Specify the directory containing code samples in the `writerside.cfg` file. This directory must exist within the documentation project.
```xml
` element of your `writerside.cfg` file to your GitHub repository name.
```xml
```
--------------------------------
### Create Basic Tab Blocks
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/tabs.html
Use `` and `` elements to create switchable content sections for different platforms or languages. Each `` requires an `id` and `title`.
```xml
How to install on Windows.
How to install on macOS.
How to install on Linux.
```
--------------------------------
### Configure Custom Banner
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Sets up a custom banner in the documentation header. Attributes control background theme, display duration, event label, and click link.
```xml
Join 2,000+ devs at KotlinConf 2026!
```
--------------------------------
### Define Build Group Configuration
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-groups.html
Use this XML structure to define build groups. Specify instance IDs and their aliases to group documentation instances for a unified build.
```xml
```
--------------------------------
### Definition List Structure
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/lists.html
Demonstrates the basic structure of definition lists using both semantic markup and Markdown.
```APIDOC
## Definition lists
Definition lists are a great way to document references of commands, options, methods, API endpoints, parameters, and UI controls. You can also use them for documenting frequently asked questions (FAQ) and troubleshooting guides.
To add a definition list, use the `` element and `` sub-elements for each definition item.
In Markdown specify the term on the first line, then on the next line, type a colon `:` followed by a space and the definition. You can specify definition list attributes in curly braces before the first term.
Semantic markup
```xml
This is the definition of the first term.
This is the definition of the second term.
```
Markdown
```markdown
First Term
: This is the definition of the first term.
Second Term
: This is the definition of the second term.
```
```
--------------------------------
### Build Docker Image
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/build-with-docker.html
Command to build a Docker image from a Dockerfile. This is used to create a custom image for building and serving documentation.
```bash
docker build -t help-website .
```
--------------------------------
### Enable Indexing for Existing Instance
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/allow-search-engine-indexing.html
Manually enable indexing for a specific instance by adding the `false ` variable to its build profile. If the variable is absent, content is not indexed by default.
```xml
false
```
--------------------------------
### Configure images web-path in writerside.cfg
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/deploy-docs-to-gitlab-pages.html
Set the `web-path` parameter for `images` to `img` in your `writerside.cfg` file to correctly reference images when deploying to GitLab Pages.
```xml
```
--------------------------------
### Linking to a Topic File
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/topics.html
Demonstrates how to create a hyperlink to a topic file in Writerside.
```html
` element to demonstrate differences between two code blocks, such as refactoring changes. The first block is shown as 'Before' and the second as 'After'.
```kotlin
if (true) {
doThis()
}
```
```kotlin
if (true) doThis()
```
--------------------------------
### Generate Full API Reference
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-api-reference.html
Use the element with the openapi-path attribute to generate a full API reference from a specified OpenAPI specification file.
```xml
https://github.com/JetBrains/intellij-sdk-docs/edit/main/
```
--------------------------------
### Specify Download Page URL
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Sets the URL for the header download button, typically linking to a product download page.
```xml
https://www.example.com/download
```
--------------------------------
### Define a redirection rule in XML
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/redirects.html
Store redirection rules in the `redirection-rules.xml` file. Each rule defines a unique ID, a description, and the old web file name to accept.
```xml
Created after removal of "Introduction" from Writerside
introduction.html
```
--------------------------------
### Configure Search Endpoint in buildprofiles.xml
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/custom-search-service.html
Specify the URL for your custom search service within the `` tag in your buildprofiles.xml file. This setting is used when building and publishing your help content.
```xml
https://my.search/endpoint
```
--------------------------------
### Display a Notice with an Icon
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/buildprofiles-xml.html
Displays a notice with a custom icon specified by the 'icon' attribute.
```xml
Notice with icon
```
--------------------------------
### Add Header Logo
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/customize-the-look.html
Specify a logo image to be displayed in the header next to the help instance name. The image should be in SVG or PNG format and meet specific aspect ratio and size requirements.
```xml
my-logo.png
```
--------------------------------
### Using the element
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/generate-api-reference.html
Demonstrates how to use the `` element to embed generated API references directly into topics, with options for filtering by tag.
```APIDOC
You can also use the `` element in any topic where you want to add a generated reference of the API specification. If necessary, add the `tag` attribute to generate a reference only for operations with a specific tag.
Full reference
Specific tag
```
{...}
```
--------------------------------
### Including Topic Elements
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/topics.html
Demonstrates how to include a specific element from a topic file into another document using the 'include' tag.
```xml
true
```
--------------------------------
### Create a basic link to another topic
Source: https://plugins.jetbrains.com/plugin/20158-writerside/docs/links-and-references.html
Use the `` element for semantic markup or standard Markdown notation for links to other topics. The link text is displayed as provided.
```html
Link text
```
```markdown
[Link text](target.topic)
```