Comprehensive documentation for the tnks-data-table component - A highly configurable and feature-rich data table built with Shadcn UI and TanStack Table.
- 🏠 Main Repository: github.com/jacksonkasi1/tnks-data-table
- 🚀 Live Demo: tnks-data-table.vercel.app
- 📦 Shadcn Registry: tnks-data-table.vercel.app/r/data-table.json
This repository contains the complete documentation for the tnks-data-table component, built with Fumadocs - a modern documentation framework.
- Getting Started - Installation, setup, and quick start guides
- API Reference - Complete prop documentation and type definitions
- Guides - Best practices, server implementation, and troubleshooting
- Configuration - Case format support, URL state management, and table customization
- Core Concepts - Data flow, state management, and performance optimization
- Features - Subrows (3 modes), data export, row selection, and more
- Examples - Orders, Bookings, and Tickets implementations
# Clone the repository
git clone https://github.com/jacksonkasi1/tnks-docs.git
cd tnks-docs
# Install dependencies
bun install
# or
npm install# Run the development server
bun dev
# or
npm run devOpen http://localhost:3000 in your browser to see the documentation.
# Build for production
bun run build
# or
npm run build
# Start production server
bun start
# or
npm start- Framework: Next.js 16
- Documentation: Fumadocs
- Styling: Tailwind CSS
- UI Components: Radix UI
- Language: TypeScript
tnks-docs/
├── content/ # MDX documentation files
│ ├── 01-getting-started/
│ ├── 02-guides/
│ ├── 03-api/
│ ├── 04-configuration/
│ ├── 05-core-concepts/
│ ├── 06-examples/
│ └── 07-features/
├── src/
│ ├── app/ # Next.js app directory
│ ├── components/ # Documentation UI components
│ └── lib/ # Utilities and helpers
├── public/ # Static assets
└── scripts/ # Build and lint scripts
Contributions to improve the documentation are welcome!
- Fork this repository
- Create a new branch (
git checkout -b improve-docs) - Make your changes
- Commit your changes (
git commit -am 'docs: improve installation guide') - Push to the branch (
git push origin improve-docs) - Open a Pull Request
This documentation is part of the tnks-data-table project and shares the same MIT license.
- Built with Fumadocs
- Powered by Next.js
- Created by Jackson Kasi
For the main data table component, visit: github.com/jacksonkasi1/tnks-data-table