mirror of
https://github.com/FranP-code/create-better-t-stack.git
synced 2025-10-12 23:52:15 +00:00
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# Better-T-Stack Website
|
|
|
|
This is the official documentation website for Better-T-Stack, built with Next.js and Fumadocs.
|
|
|
|
## Getting Started
|
|
|
|
To run the development server:
|
|
|
|
```bash
|
|
# Install dependencies
|
|
npm install
|
|
# or
|
|
pnpm install
|
|
# or
|
|
bun install
|
|
|
|
# Start development server
|
|
npm run dev
|
|
# or
|
|
pnpm dev
|
|
# or
|
|
bun dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) with your browser to see the site.
|
|
|
|
## Project Structure
|
|
|
|
- `/src/app` - Next.js application routes
|
|
- `/src/content` - Documentation content in MDX format
|
|
- `/public` - Static assets
|
|
|
|
## Contributing to Documentation
|
|
|
|
To add or modify documentation:
|
|
|
|
1. Edit the appropriate MDX files in the `src/content` directory
|
|
2. Run the development server to preview your changes
|
|
3. Submit a pull request with your updates
|
|
|
|
## Learn More
|
|
|
|
To learn more about the technologies used in this website:
|
|
|
|
- [Next.js Documentation](https://nextjs.org/docs) - Next.js features and API
|
|
- [Fumadocs](https://fumadocs.vercel.app) - The documentation framework used
|
|
- [Better-T-Stack](https://better-t-stack.dev) - Main project site
|