vitedoc

Appearance

vitedoc.utils ​

Classes ​

Action ​

vitedoc.utils.Action

Represents an action element.

Arguments ​

  • theme (str): The name of the theme. Supported themes are brand and alt.
  • text (str): The text to display on the action button.
  • link (str): The URL to navigate to when the action button is clicked.

Feature ​

vitedoc.utils.Feature

Represents a feature element.

Arguments ​

  • icon_emoji (str): The emoji icon to use. Defaults to None.
  • icon_path (str): The path to the icon. Defaults to None.
  • title (str): The title of the feature. Defaults to None.
  • details (str): The details of the feature. Defaults to None.

Notes ​

icon_emoji and icon_path mutually exclusive. If both are provided, icon_emoji will take precedence.