Skip to content

Component Guide

This page demonstrates the rich interactive components available in our documentation, inspired by modern documentation platforms.

Steps Component

Use ordered lists with the .steps class for visual step-by-step guides:

  1. Clone the repository 
    git clone https://github.com/traylinx/your-project.git
cd your-project
  2. Install dependencies Use your preferred package manager: 
    poetry install
# or
pip install -r requirements.txt
  3. Configure environment Copy the example environment file and update with your credentials: 
    cp .env.example .env
  4. Run the application Start the development server: 
    poetry run uvicorn app.main:app --reload

Content Badges

Mark your content type using badges:

Tutorial How-To Reference Explanation

Card Groups

Use card groups for landing pages and navigation hubs:

🚀

Quick Start

Get up and running in 5 minutes

 🧠

Cortex

Intelligent memory and LLM routing

 🌐

Stargate Network

Decentralized agent discovery

 🐍

Python SDK

Build agents with Python

Frame Component

Wrap images in a .frame for subtle borders:

![Traylinx Architecture](../assets/logo.svg)

Tabbed Content

Use tabs (already built-in) for platform-specific instructions:

from traylinx import Agent

agent = Agent(name="my-agent")
agent.run()

import { Agent } from '@traylinx/sdk';

const agent = new Agent({ name: 'my-agent' });
agent.run();

traylinx agent run --name my-agent