Skip to content

Treblle/docs.treblle.com

Repository files navigation

Treblle Documentation

This repository contains the official documentation for Treblle. Treblle is an API Ops platform that helps engineers and product teams build, ship, and understand their REST APIs in one single place. The documentation is built using Astro, a modern static site generator.

🚀 Quick Start

  1. Clone the repository:

    git clone https://github.com/Treblle/docs.treblle.com.git
    cd docs.treblle.com
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

📚 Documentation Structure

  • /src/content/docs/ - Main documentation content
    • /treblle/ - Core Treblle features and functionality
    • /integrations/ - Integration guides for different platforms
    • /features/ - Detailed feature documentation

🛠️ Contributing

We welcome contributions! If you'd like to improve our documentation:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Please ensure your documentation follows our style guide and includes clear, concise explanations.

🔧 Local Development

The documentation site is built with:

  • Astro - Static site generator
  • Starlight - Documentation theme
  • MDX - Markdown with JSX support

📝 License

MIT License

🤝 Support

If you need help or have questions:

Releases

No releases published

Packages

No packages published