📚 Welcome to Tawtheeq
Tawtheeq is a modern, free, and open-source documentation platform designed to empower developers and teams to create, organize, and share beautiful documentation with ease. We focus on providing a user-friendly, collaborative, and powerful documentation experience, making Tawtheeq the ideal choice for projects of all sizes.
🚀What is Tawtheeq?
Tawtheeq is an open-source documentation platform that transforms the way teams create and maintain documentation. Built with modern technologies and designed for collaboration, it offers a seamless experience for writing, organizing, and sharing knowledge across teams and communities.
⚡Quick Start
Get started with Tawtheeq in minutes. Create your first documentation project and start writing beautiful docs with markdown support, collaborative editing, and real-time preview.
# Getting Started with Tawtheeq
## Installation
npm install -g tawtheeq
tawtheeq init my-docs
cd my-docs
tawtheeq serve
## Your first documentation page
Welcome to **Tawtheeq**! 🎉
This is your first documentation page.
You can write in markdown and see
changes in real-time!Your documentation site will be available at localhost:3000 with live reload enabled!
✨Core Features
Tawtheeq is packed with features that make documentation creation and maintenance a breeze for individuals and teams.
Rich Markdown Support
Write documentation using extended Markdown with support for tables, code blocks, math equations, diagrams, and custom components for enhanced content creation.
Real-time Collaboration
Collaborate with your team in real-time with live editing, comments, suggestions, and version control integration to streamline your documentation workflow.
Beautiful Themes
Choose from a variety of professionally designed themes or create your own. Customize colors, fonts, and layouts to match your brand and style preferences.
Powerful Search
Built-in full-text search with advanced filters, tagging system, and AI-powered content discovery to help users find information quickly and efficiently.
Easy Deployment
Deploy your documentation to popular hosting platforms with one click. Support for GitHub Pages, Netlify, Vercel, and custom domains with SSL certificates.
Rich Integrations
Connect with your favorite tools including GitHub, GitLab, Slack, Discord, and more. Sync content, get notifications, and maintain consistency across platforms.
🤝Contributing
Tawtheeq is an open-source project and we welcome contributions from the community. Whether it's reporting a bug, suggesting a feature, improving documentation, or writing code, your help makes Tawtheeq better for everyone. Join our community and help us build the future of documentation.