Official documentation site for S.EE - A modern URL shortener service.
- Framework: Next.js 16
- Documentation: Fumadocs
- Styling: Tailwind CSS 4
- Runtime: Bun
- MDX-based documentation
- OpenAPI documentation auto-generation
- Full-text search
- Dark/Light mode
- Copy Markdown for LLM
- Open in ChatGPT/Claude integration
- Clerk-style Table of Contents
- Responsive design
- Bun (v1.0 or higher)
# Clone the repository
git clone https://github.com/sdotee/docs.git
cd docs
# Install dependencies
bun install# Start development server
bun devOpen http://localhost:3000/docs/ in your browser.
# Build for production
bun run build
# Start production server
bun run start.
├── app/ # Next.js App Router
│ ├── docs/ # Documentation pages
│ └── llms.mdx/ # LLM markdown API routes
├── content/
│ └── docs/ # MDX documentation files
│ └── api/ # Auto-generated API docs
├── components/ # React components
├── lib/ # Utility functions
├── scripts/ # Build scripts
│ ├── generate-docs.ts # OpenAPI docs generator
│ └── generate-sitemap.ts
├── openapi_swagger.yaml # OpenAPI specification
└── source.config.ts # Fumadocs MDX config
Documentation is written in MDX format in the content/docs/ directory.
- Create a new
.mdxfile incontent/docs/ - Add frontmatter with
titleanddescription - Write your content in MDX
Example:
---
title: My Page
description: A description of my page
icon: FileText
---
# My Page
Your content here...API documentation is auto-generated from openapi_swagger.yaml during the build process. To update API docs:
- Edit
openapi_swagger.yaml - Run
bun run build:preorbun run build
# Build image
docker build -t see-docs .
# Run container
docker run -p 3000:3000 see-docsMIT