<html><head><link rel="canonical" href="https://www.jetbrains.com/help/writerside/customize-the-look.html.md/" data-react-helmet="true"/></head><body># Customize output

Writerside builds a modern-looking documentation website with a fixed layout and dark mode support. The layout is adapted for a wide range of display sizes, from mobile devices to desktop monitors. Writerside also provides some customization, such as the accent color, site logo, and favicon.

&gt; **Note:**
&gt; Output customization does not apply when publishing to [JetBrains Marketplace](https://plugins.jetbrains.com/) because such documentation is embedded in a tab on the plugin page.

You can customize the output in the build configuration file:  `[buildprofiles.xml](buildprofiles-xml.html)` .

If you do not have this file yet, create it in your [help module](projects.html#help_module) root under  [cfg directory](help-modules.html#build-config-dir) . Here is an example that you can use:

```XML
<!--?xml version="1.0" encoding="UTF-8"?-->

<buildprofiles xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nonamespaceschemalocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd">
    <variables>
        <primary-color>aqua</primary-color>
        <custom-favicons>favicon.png</custom-favicons>
        <header-logo>my-logo.png</header-logo>
        <product-web-url>https://help.example.com</product-web-url>
        <download-title>Get Awesome App</download-title>
        <download-page>https://example.com</download-page>
        <showdownloadbutton>true</showdownloadbutton>
    </variables>
</buildprofiles>
```

&gt; **Tip:**
&gt; To create the `buildprofiles.xml` file, you can right-click the  [build configuration directory](help-modules.html#build-config-dir)  (`cfg` by default) in the Project tool window, select New, and then click buildprofiles.xml.

When editing  `[buildprofiles.xml](buildprofiles-xml.html)` , the preview shows a synthetic topic with instructions about the output customization options that are available. You can immediately see how the changes affect the output.

Procedure: Change accent color

The accent color is applied to various UI components, such as the focused items in the [TOC](table-of-contents.html), active tabs, and buttons.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Use the  `[&lt;primary-color&gt;](buildprofiles-xml.html#primary-color)`  element under  `[&lt;variables&gt;](buildprofiles-xml.html#variables)`  and specify a color in HEX format or choose from the following values:

* blueberry

* purple

* iris

* strawberry

* dracula

* ruby

* halloween

* emerald

* forest

* deep ocean

* metallic

* aqua

* frozen (default)

&gt; **Tip:**
&gt; You can also click the color icon in the gutter and select the color in the picker popup.

You should be able to see the configured color in the [local preview](preview-topics.html).

![Accent color change in preview](https://resources.jetbrains.com/help/img/writerside/change-color.gif)

Use the  `[&lt;color-preset&gt;](buildprofiles-xml.html#color-preset)`  element to configure the intensity of the primary accent color.

contrast
: Default look with moderate contrasting.

soft
: Minimal contrasting touch of the primary accent color.

vivid
: Most contrasting usage of the primary accent color.

Procedure: Change link color

By default, link font color is the same as the main text. Link text is underlined to differentiate it from other elements on the page.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Use the  `[&lt;link-color&gt;](buildprofiles-xml.html#link-color)`  element under  `[&lt;variables&gt;](buildprofiles-xml.html#variables)`  and specify a color in HEX format or choose from the following values:

* blueberry

* purple

* iris

* strawberry

* dracula

* ruby

* halloween

* emerald

* forest

* deep ocean

* metallic

* aqua

* frozen

```XML
<link-color>#24AFD0</link-color>
```

&gt; **Tip:**
&gt; You can also click the color icon in the gutter and select the color in the picker popup.

You should be able to see the configured color in the [local preview](preview-topics.html).

Procedure: Change main content width

By default, the maximum width of the main content pane is 1165 pixels.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Use the  `[&lt;content-max-width&gt;](buildprofiles-xml.html#content-max-width)`  element under  `[&lt;variables&gt;](buildprofiles-xml.html#variables)`  and specify the maximum width in pixels.

```XML
<content-max-width>500</content-max-width>
```

You should be able to see the configured width in the [local preview](preview-topics.html).

Procedure: Change TOC width

By default, the width of the table of contents pane is 300 pixels.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Use the  `[&lt;sidebar-width&gt;](buildprofiles-xml.html#sidebar-width)`  element under  `[&lt;variables&gt;](buildprofiles-xml.html#variables)`  and specify the width in pixels.

```XML
<sidebar-width>200</sidebar-width>
```

You should be able to see the configured width in the [local preview](preview-topics.html).

&gt; **Tip:**
&gt; You can make the sidebar with the table of contents resizeable by adding  `[&lt;resizable-sidebar&gt;](buildprofiles-xml.html#resizable-sidebar)` .
&gt;
&gt;
&gt;
&gt;
&gt; ```XML
&gt; <resizable-sidebar>true</resizable-sidebar>
&gt; ```

Procedure: Change favicon

Web browsers can display the [favicon](https://en.wikipedia.org/wiki/Favicon) on tabs, in the address bar, browsing history, and bookmarks. Similar to the [header logo](#header-logo), set the favicon to represent your company, product, or project.

By default, Writerside uses the JetBrains logo: ![Writerside Logo](https://resources.jetbrains.com/help/img/writerside/writerside.svg)

1. Put the favicon image into the  [images directory](help-modules.html#images-dir)  in your project or host it on some publicly accessible web server.

&gt; **Note:**
&gt; Supported formats are SVG, PNG, and ICO. However, keep in mind that [Safari](https://www.apple.com/safari/) and some other modern browsers do not support SVG favicons.
&gt;
&gt;
&gt;
&gt; You can use up to five favicons in different sizes: 16x16, 32x32, 96x96, 300x300, 500x500.

2. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

3. Use the `<custom-favicons>` element under `<variables>` to specify the icons.

Single local favicon:

```XML
<custom-favicons>favicon.png</custom-favicons>
```

Single favicon as a URL:

```XML
<custom-favicons>https://www.jetbrains.com/icon.svg</custom-favicons>
```

Multiple favicons ordered by size:

```XML
<custom-favicons>icon16.png,icon32.png,icon96.png,icon300.png,icon500.png</custom-favicons>
```

Procedure: Add header logo

You can add the logo of your company, product, or project in the header next to the help instance name.

1. Put the logo image into the  [images directory](help-modules.html#images-dir)  in your project.

&gt; **Note:**
&gt; Logo image requirements are:
&gt;
&gt;
&gt;
&gt; * SVG or PNG format. We recommend using SVG for better quality on Retina and 4K displays.
&gt;
&gt; * Height-to-width aspect ratio between 1.2 and 0.24. We recommend using square images.
&gt;
&gt; * Image height more than 48px.

2. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

3. Use the `<header-logo>` element under `<variables>` to specify the logo filename.

```XML
<header-logo>my-logo.png</header-logo>
```

4. If necessary, use the `<product-web-url>` element to add a URL that should open when your readers click the header logo. This is usually the home page of your help website, but you can also reference your company website or your project repository.

```XML
<product-web-url>https://help.example.com</product-web-url>
```

Procedure: Add header button

You can add a button in the header with a link to the download location of the app, your corporate website, or the repository of your project.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Specify the text and URL, and enable the button:

```XML
<download-title>Get Awesome App</download-title>
<download-page>https://example.com</download-page>
<showdownloadbutton>true</showdownloadbutton>
```

&gt; **Note:**
&gt; `<download-page>` and `<showdownloadbutton>` are required, while the `<download-title>` element is optional. Without it, Writerside will insert a button with the default text `Get %instance%`, where `%instance%` is the name of the current [instance](instances.html).

Procedure: Add custom banner

If you want to promote an event via your documentation pages, you can add a custom banner with an announcement that will render on every page under the header.

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)` .

2. Use the `<custom-banner>` element under `<variables>` to specify the text in the banner.

```XML
<custom-banner>Visit our conference!</custom-banner>
```

3. Optionally, specify additional attributes to set the label, link, date, and background color theme.

```XML
<custom-banner label="Conference" link="https://kotlinconf.com/" date="2026-05-20" bg-theme="strawberry">KotlinConf, Munich</custom-banner>
```

For more information, see  `[&lt;custom-banner&gt;](buildprofiles-xml.html#custom-banner)` .

## Customize footer

Writerside lets you customize the footer to improve navigation to product-related resources and make your documentation website more visually appealing. You can add links to social media and other resources, copyright information, and support contacts.

Procedure:

1. Open  `[buildprofiles.xml](buildprofiles-xml.html)`  or create it if you do not have it yet.

2. Specify the footer configuration parameters inside the  `[&lt;footer&gt;](buildprofiles-xml.html#footer)`  element. For example:

```XML
<footer>
    <copyright>2000 JetBrains s.r.o.</copyright>
    <social type="twitter" href="https://twitter.com/onwriterside">
    <link href="https://blog.jetbrains.com">Blog
</social></footer>
```

Here are the available parameters:

copyright
: Copyright information that usually mentions the company or legal entity name, with the year when the content was created or a range of years.
:
:
:
:
:
:
: ```XML
: <copyright>2000 JetBrains s.r.o.</copyright>
: ```
:
:
:
:
:
: The previous example will be rendered as `Copyright © 2000 JetBrains s.r.o.`.

icp
: Information about the Internet Content Provider license.
:
:
:
:
: ```XML
: <icp>12345</icp>
: ```
:
:
:
:
:
: The previous example will be rendered as `Shangai ICP 12345`.

social
: Link to a social media resource, which will be rendered with the corresponding icon. Use the  `[type](buildprofiles-xml.html#social_type)`  attribute to specify the social media type, such as `twitter` or `github`. Use the `href` attribute to specify the URL.
:
:
:
:
: ```XML
: <social type="github" : href="https://github.com/MyCompany/my-sources">
: ```
:
:
:
: You can also add text inside the `<social>` tag, which will render as a tooltip for the icon on hover:
:
:
:
:
: ```XML
: <social type="github" : href="https://github.com/MyCompany/my-sources">
: Repository on GitHub
: </social>
: ```

link
: Link to an external resource, for example, the support forum, terms of use, or a licensing policy. The text you put inside the tag will serve as the title. Use the `href`  attribute to specify the URL.
:
:
:
:
:
:
: ```XML
: <link href="https://blog.jetbrains.com">JetBrains Blog
: <link href="https://slack.jetbrains.com">JetBrains Slack
: ```

This is how an empty footer looks by default:

![An empty footer example](https://resources.jetbrains.com/help/img/writerside/footer-empty.png)

This is how the footer looks with a copyright notice and two social links:

![A footer example](https://resources.jetbrains.com/help/img/writerside/footer-example1.png)

```XML
<footer>
    <copyright>Product 2023</copyright>
    <social type="blog" href="https://blog.jetbrains.com/writerside/">
    <social type="twitter" href="https://twitter.com/onwriterside">
</social></social></footer>
```

This is how the footer looks with all possible elements:

![A footer example](https://resources.jetbrains.com/help/img/writerside/footer-example2.png)

```XML
<footer>
    <copyright>Product 2000-2023</copyright>
    <icp>123456789</icp>
    <social type="blog" href="https://blog.jetbrains.com/writerside/">
    <social type="twitter" href="https://twitter.com/onwriterside">
    <social type="facebook" href="https://www.facebook.com/JetBrains">
    <link href="https://slack.example.com">Slack community
    <link href="https://stackoverflow.com">StackOverflow
    <link href="https://example.com/terms-an-conditions.html">Terms and conditions
    <link href="https://example.com/code-of-conduct.html">Code of Conduct
</social></social></social></footer>
```

</social></social></variables></custom-banner></download-title></showdownloadbutton></download-page></product-web-url></variables></header-logo></variables></custom-favicons></body></html>