ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

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

ScyllaDB Docs ScyllaDB Sphinx Theme Examples Hero box

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.

button_icon

string

fa fa-home

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

button text

string

Lorem ipsum

Text for the call to action.

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_icon: fa fa-github
    :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.

Was this page helpful?

PREVIOUS
Headings
NEXT
Includes
ScyllaDB Sphinx Theme
  • master
    • 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
    • Troubleshooting
  • 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.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
  • 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
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 02 Jun 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.5.1