Documentation

Customize Your Documentation's Homepage (Hero Section)

The hero section is the first thing your users see on your documentation homepage, featuring the main title, subtitle, and a brief description. This guide will show you how to customize these elements to create a professional and welcoming entry point for your readers. Before you begin, ensure you have already published your project.

  1. From your project's main editor, click the Project Settings icon at the top of the left sidebar.

  2. In the Project Settings window, select Publishing from the left-hand menu.

  3. Click the Hero Section tab.

  4. In the Title field, enter the main title for your documentation homepage.

  5. In the Subtitle field, add a short subtitle that appears below the main title.

  6. In the Description field, write a brief introduction to your documentation.

    Documentation image

  7. Once you are satisfied with your changes, click the Save Settings button.

  8. To make your changes live, click the Publish Changes button at the top of the Publishing section.

Documentation image

A Helpful Tip

As you edit the title, subtitle, and description, a live Preview box will update to show you how your hero section will appear on the published homepage. Use this preview to adjust your content before saving.

Summary

This article guides you through customizing the hero section of your published documentation. By editing the title, subtitle, and description, you can create a branded and informative homepage that effectively introduces users to your content and helps them get started quickly.