Skip to content

jacksonkasi1/tnks-docs

Repository files navigation

📚 tnks-data-table Documentation

Comprehensive documentation for the tnks-data-table component - A highly configurable and feature-rich data table built with Shadcn UI and TanStack Table.

🔗 Project Links


📖 About This Documentation

This repository contains the complete documentation for the tnks-data-table component, built with Fumadocs - a modern documentation framework.

What's Included

  • 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

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/jacksonkasi1/tnks-docs.git
cd tnks-docs

# Install dependencies
bun install
# or
npm install

Development

# Run the development server
bun dev
# or
npm run dev

Open http://localhost:3000 in your browser to see the documentation.

Build

# Build for production
bun run build
# or
npm run build

# Start production server
bun start
# or
npm start

🛠️ Tech Stack


📁 Project Structure

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

🤝 Contributing

Contributions to improve the documentation are welcome!

  1. Fork this repository
  2. Create a new branch (git checkout -b improve-docs)
  3. Make your changes
  4. Commit your changes (git commit -am 'docs: improve installation guide')
  5. Push to the branch (git push origin improve-docs)
  6. Open a Pull Request

📝 License

This documentation is part of the tnks-data-table project and shares the same MIT license.


🙏 Acknowledgments


For the main data table component, visit: github.com/jacksonkasi1/tnks-data-table

About

Comprehensive documentation for tnks-data-table - Built with Fumadocs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages