v2

API Reference

Complete API reference documentation

1 min read

API Reference

Complete reference for all APIs and components available in Hermes.

Components

Callout

Display important information, warnings, or tips.

<Callout type="info" title="Note">
  This is an informational callout.
</Callout>

<Callout type="warning">
  This is a warning callout.
</Callout>

Props:

  • type: 'info' | 'warning' | 'success' | 'danger' (default: 'info')
  • title: Optional title string

Tabs

Display content in tabs for multi-language examples or different views.

<Tabs items={['JavaScript', 'TypeScript', 'Python']}>
  <div>JavaScript code here</div>
  <div>TypeScript code here</div>
  <div>Python code here</div>
</Tabs>

CodeBlock

Enhanced code blocks with syntax highlighting and copy functionality.

<CodeBlock
  code="const hello = 'world';"
  language="javascript"
  filename="example.js"
  highlight="1,3-5"
/>

APIEndpoint

Display API endpoint documentation.

<APIEndpoint method="GET" path="/api/users" description="Get all users">
  Request body and response details here...
</APIEndpoint>

CLICommand

Display CLI commands with copy functionality.

<CLICommand command="npm install" description="Install dependencies" />

Configuration

All configuration is done in src/config.ts. See the Configuration Guide for details.