Writerside Help

Customize the look

Writerside builds a modern-looking web help 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. You can customize the output in the build configuration file: buildprofiles.xml.

If you do not have this file yet, create it. Here is an example that you can use:

<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>

Change accent color

The accent color is applied to various UI components, such as the focused items in the TOC, active tabs, and buttons.

  1. Open buildprofiles.xml.

  2. Use the <primary-color> element under <variables> and choose from the following values:

    • blueberry

    • purple

    • iris

    • strawberry

    • dracula

    • ruby

    • halloween

    • emerald

    • forest

    • deep-ocean

    • metallic

    • aqua

    • frozen (default)

You should be able to see the configured color in the local preview.

Accent color change in preview

Use the <color-preset> element to configure the intensity of the primary accent color.

vivid

Most contrasting usage of the primary accent color.

contrast

Default look with moderate contrasting.

soft

Minimal contrasting touch of the primary accent color.

Change favicon

Web browsers can display the favicon on tabs, in the address bar, browsing history, and bookmarks. Similar to the header logo, set the favicon to represent your company, product, or project.

By default, Writerside uses the JetBrains logo: JetBrains Logo

  1. Put the favicon image into the images directory in your project or host it on some publicly accessible web server.

  2. Open buildprofiles.xml.

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

    Single local favicon:

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

    Single favicon as a URL:

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

    Multiple favicons ordered by size:

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

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 in your project.

  2. Open buildprofiles.xml.

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

    <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.

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

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.

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

    <download-title>Get Awesome App</download-title> <download-page>https://example.com</download-page> <showDownloadButton>true</showDownloadButton>
Last modified: 26 March 2024