ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Hero box

Caution

You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

Hero box¶

A custom directive to create a header on the root index.rst file.

Warning

Do not use the hero-box on the subordinate index.rst files.

Syntax¶

.. hero-box::
   <options>

   <text>

Options¶

The hero-box directive supports the following options:

Option

Type

Required

Example Value

Description

title

string

Lorem ipsum

Hero box title.

class

string

Custom CSS class.

cta

string

Learn more

Call to action text next to the button.

button_icon

string

fa fa-home

A list of CSS classes to render an icon, separated by comma or space.

button_icon_position

string

left

Position of the icon in relation to the text. Available values: left, right. Defaults to left.

button_icon_link

flag

If set, applies the CTA color to the icon.

button text

string

Lorem ipsum

Text for the call to action.

button_style

string

bold

Apply specific style to the button. Available values: default, bold. Defaults to default.

button_url

string

Relative link or external URL for the call to action. Do not use leading and trailing (“/”) symbols to define relative links. (e.g. instead of /getting-started/, use getting-started).

image

string

/_static/img/mascots/scylla-enterprise.svg

Path to the image. The image should be located in the project’s _static folder.

search_box

flag

If set, displays the site’s search box.

Usage¶

Default¶

Using:

.. hero-box::
    :title: Lorem Ipsum

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with image¶

Using:

.. hero-box::
    :title: Lorem Ipsum
    :image: /_static/img/mascots/scylla-enterprise.svg

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with search box¶

Using:

.. hero-box::
    :title: Lorem Ipsum
    :search_box:

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with button¶

Using:

.. hero-box::
    :title: Lorem Ipsum
    :image: /_static/img/mascots/scylla-enterprise.svg
    :button_url: #
    :button_text: Project Name

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with button & icon¶

Using:

.. hero-box::
    :title: Lorem Ipsum
    :image: /_static/img/mascots/scylla-enterprise.svg
    :button_url: #
    :button_icon: fa fa-github
    :button_text: Project Name

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with button & icon (position right)¶

Using:

.. hero-box::
    :title: Lorem Ipsum
    :image: /_static/img/mascots/scylla-enterprise.svg
    :button_url: #
    :button_icon: fa fa-github
    :button_icon_position: right
    :button_text: Project Name

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with bold button¶

Using:

.. hero-box::
    :title: Lorem ipsum
    :button_text: Project Name
    :button_url: #
    :button_style: bold

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero with colored button¶

Using:

.. hero-box::
    :title: Lorem ipsum
    :button_text: Project Name
    :button_url: #
    :button_icon_link:

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box button with CTA¶

Using:

.. hero-box::
    :title: Lorem ipsum
    :button_text: Project Name
    :button_url: #
    :cta: Learn more

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hero box with everything¶

.. hero-box::
    :title: Lorem ipsum
    :image: /_static/img/mascots/scylla-enterprise.svg
    :button_text: Project Name
    :button_url: #
    :button_style: bold
    :button_icon: fa fa-github
    :button_icon_position: right
    :button_icon_link:
    :cta: Learn more
    :search_box:

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Results in:

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Was this page helpful?

PREVIOUS
Headings
NEXT
Includes
  • Create an issue
  • Edit this page

On this page

  • Hero box
    • Syntax
    • Options
    • Usage
      • Default
      • Hero box with image
      • Hero box with search box
      • Hero box with button
      • Hero box with button & icon
      • Hero box with button & icon (position right)
      • Hero box with bold button
      • Hero with colored button
      • Hero box button with CTA
      • Hero box with everything
ScyllaDB Sphinx Theme
  • 1.7
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.6 to 1.7
    • Migrating from 1.5 to 1.6
    • Migrating from 1.4 to 1.5
    • Migrating from 1.3 to 1.4
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 01 Apr 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI