Skip to content

iamsr/thenex

Repository files navigation

thenex

✨ Open-source, AI-powered API documentation platform — inspired by Theneo and Stripe Docs.

thenex is an open-source platform for generating beautiful, interactive API documentation from OpenAPI specifications. It combines elegant design, AI-powered content generation, and developer-friendly workflows.


✨ Features

  • OpenAPI 3.x Support — Import and sync your API specifications
  • Beautiful UI — Stripe/Theneo-inspired documentation interface
  • Interactive Console — Test API endpoints directly in the docs
  • Multi-Language Code Samples — Python, JavaScript, Ruby, Go, and more
  • Custom Theming — Customize logos, colors, and light/dark modes
  • Docs-as-Code — Markdown and YAML-based workflows (WIP)
  • AI-Powered — Generate summaries and code samples automatically (WIP)

🚀 Quick Start

Prerequisites

  • Node.js 20.x or higher
  • pnpm 8.15.6 or higher

Installation

  1. Clone the repository
git clone https://github.com/iamsr/thenex.git
cd thenex
  1. Install dependencies
pnpm install

Development

Run the development server:

pnpm dev

This will start:

  • Web app at http://localhost:5173 (Vite dev server)
  • CLI in watch mode for development

Building

Build all packages and applications:

pnpm build

Build outputs will be in the dist/ directories of each package.

Linting

Run ESLint across all packages:

pnpm lint

Formatting

Format code with Prettier:

pnpm format

📁 Project Structure

This is a monorepo managed with Turborepo and pnpm workspaces:

thenex/
├── apps/
│   ├── web/          # Main documentation web application (React + Vite)
│   └── cli/          # Command-line interface for thenex
├── packages/
│   ├── core/         # Core business logic and utilities
│   ├── sdk-generator/# SDK generation from OpenAPI specs
│   ├── ui/           # Shared UI components
│   ├── eslint-config/# Shared ESLint configuration
│   └── typescript-config/ # Shared TypeScript configuration
└── package.json      # Root workspace configuration

Key Technologies

  • Frontend: React 19, Vite, TailwindCSS 4
  • Routing: React Router
  • State Management: Zustand
  • Markdown: MDX Bundler, React Markdown
  • Syntax Highlighting: React Syntax Highlighter
  • Build Tool: Turborepo
  • Package Manager: pnpm

🛠️ Available Commands

Command Description
pnpm dev Start development servers for all apps
pnpm build Build all packages and apps for production
pnpm lint Run ESLint on all packages
pnpm format Format code with Prettier

📝 License

thenex is open-source under the MIT License. See LICENSE.md for details.

thenex Pro

Advanced features (RBAC, multi-user collaboration, analytics) will be available under thenex Pro with a separate commercial license.


🤝 Contributing

Contributions are welcome! Please check our CONTRIBUTING.md for guidelines.

Code of Conduct

Please read our Code of Conduct to ensure a welcoming environment for all contributors.


🙌 Acknowledgments

Inspired by:


💖 Support

  • ⭐ Star this repository
  • 🐛 Report bugs and request features
  • 🧑‍💻 Contribute code
  • 📢 Share with others

About

Convert openapi spec to stripe like api documentation

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages