DocsIt - Free & Open Source AI-Powered Documentation Platform

DocsIt is a completely free and open-source documentation platform that revolutionizes how you create, manage, and share knowledge. Built with modern web technologies and powered by AI, DocsIt provides all the tools you need to create beautiful, collaborative documentation without any cost or limitations.

🌟 What DocsIt Does

DocsIt transforms the way teams create and manage documentation by providing:

AI-Powered Content Generation: Let AI write, edit, and improve your documentation automatically
Real-time Collaboration: Work together with your team in real-time, anywhere in the world
Rich Text Editing: Beautiful, intuitive editor with support for blocks, embeds, and code
Smart Organization: Hierarchical document structure with easy navigation and search
Template Gallery: Pre-built templates for common documentation needs
Version Control: Track changes and collaborate with confidence
Cross-Platform Access: Works seamlessly on desktop and mobile devices

🆓 Completely Free & Open Source

✅ 100% Free - No subscriptions, no premium tiers, no hidden costs
✅ Open Source - Full source code available, contribute and customize
✅ Self-Hostable - Deploy on your own infrastructure
✅ No Vendor Lock-in - Your data stays with you
✅ Community Driven - Built by developers, for developers

🚀 Key Features

🤖 AI-Powered Intelligence

Content Generation: Generate documentation from scratch using AI
Smart Suggestions: Context-aware AI that learns from your writing style
Auto-Complete: Intelligent suggestions as you type
Content Enhancement: Improve existing content with AI assistance

📝 Rich Editing Experience

Block-Based Editor: Modern editor with support for various content blocks
Code Highlighting: Syntax highlighting for 100+ programming languages
Embeds & Media: Support for images, videos, code blocks, and more
Math Equations: LaTeX support for mathematical expressions
Tables & Lists: Rich formatting options for structured content

🔄 Real-Time Collaboration

Live Editing: See changes from team members in real-time
Comments & Reviews: Collaborative feedback system
User Presence: See who's online and editing
Conflict Resolution: Smart merge capabilities for simultaneous edits

🗂️ Smart Organization

Hierarchical Structure: Nested documents with parent-child relationships
Full-Text Search: Find any content across all documents instantly
Tags & Categories: Organize content with flexible tagging
Navigation Trees: Easy-to-use sidebar navigation

🔐 Security & Privacy

Secure Authentication: Email/password and OAuth support
Access Controls: Fine-grained permissions for documents and folders
Data Privacy: Your content stays private and secure
Backup & Export: Easy data export and backup options

🛠️ Tech Stack

Frontend: Next.js 13, React, TypeScript, Tailwind CSS
Backend: Appwrite (Database, Authentication, Storage)
AI Integration: Gemini AI for content generation
Editor: BlockNote (Rich text editor)
UI Components: Radix UI primitives with shadcn/ui
Styling: Tailwind CSS with custom design system
Icons: Lucide React
State Management: Zustand

🚀 Quick Start

Prerequisites

Node.js 18+ and npm
Appwrite account (cloud or self-hosted)

1. Clone the Repository

git clone https://github.com/your-username/docsit.git
cd docsit

2. Install Dependencies

npm install

3. Environment Setup

Create a .env.local file in the root directory:

# Appwrite Configuration
NEXT_PUBLIC_APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1
NEXT_PUBLIC_APPWRITE_PROJECT_ID=your_project_id_here
NEXT_PUBLIC_APPWRITE_DATABASE_ID=notion-clone-db
NEXT_PUBLIC_APPWRITE_DOCUMENTS_COLLECTION_ID=documents
NEXT_PUBLIC_APPWRITE_STORAGE_BUCKET_ID=cover-images

# Gemini AI (Optional - for AI features)
GEMINI_API_KEY=your_gemini_api_key_here

4. Appwrite Setup

Create Project: Go to Appwrite Cloud and create a new project
Enable Authentication: Navigate to Auth → Settings and enable Email/Password authentication
Create Database: The required database schema will be created automatically
Storage Bucket: Create a bucket named cover-images with appropriate permissions

5. Run the Development Server

npm run dev

Open http://localhost:3000 to see DocsIt in action!

📚 Project Structure

docsit/
├── app/
│   ├── (main)/              # Authenticated app routes
│   │   ├── _components/     # Main app components
│   │   └── (routes)/        # Document management routes
│   ├── (marketing)/         # Landing page and marketing
│   ├── (public)/            # Public document preview
│   └── api/                 # API routes and AI endpoints
├── components/
│   ├── blocks/              # Document block components
│   ├── modals/              # Modal dialogs
│   ├── providers/           # Context providers
│   └── ui/                  # Reusable UI components
├── lib/
│   ├── appwrite*.ts         # Appwrite service integrations
│   ├── gemini-ai.ts         # AI integration
│   ├── templates/           # Document templates
│   └── utils.ts             # Utility functions
└── public/                  # Static assets

🎯 Use Cases

For Development Teams

API Documentation: Create and maintain comprehensive API docs
Technical Guides: Write installation and setup guides
Code Documentation: Document codebases with rich formatting
Project Planning: Plan and track project milestones

For Product Teams

Product Requirements: Create detailed PRDs and specifications
User Guides: Build customer-facing documentation
Process Documentation: Document workflows and procedures
Meeting Notes: Collaborative note-taking and action items

For Content Teams

Content Strategy: Plan and organize content calendars
Style Guides: Maintain brand and writing guidelines
Knowledge Base: Build searchable knowledge repositories
Training Materials: Create onboarding and training docs

🤝 Contributing

We welcome contributions from the community! DocsIt is open source and thrives on community involvement.

Ways to Contribute

🐛 Report Bugs: Help us identify and fix issues
💡 Feature Requests: Suggest new features and improvements
🔧 Code Contributions: Submit pull requests with bug fixes or features
📖 Documentation: Improve our docs and guides
🌐 Translations: Help translate DocsIt to other languages

Development Setup

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Make your changes and commit: git commit -m 'Add amazing feature'
Push to the branch: git push origin feature/amazing-feature
Open a Pull Request

📄 License

DocsIt is released under the MIT License. This means you can:

✅ Use it commercially
✅ Modify and distribute
✅ Private use
✅ Patent use

🌍 Community & Support

GitHub Issues: Report bugs and request features
Discussions: Join community discussions
Documentation: Full documentation and guides

🚀 Deployment

Deploy on Vercel (Recommended)

Self-Hosting Options

Docker: Use our Docker configuration for easy deployment
VPS: Deploy on any Linux server with Node.js
Cloud Platforms: Deploy on AWS, Google Cloud, or Azure

🔮 Roadmap

Real-time Collaboration Enhancements: Advanced conflict resolution
API Documentation: REST API for integrations
Plugin System: Extensible architecture for custom features
Advanced AI Features: More AI-powered content tools
Mobile Apps: Native iOS and Android applications
Enterprise Features: SSO, advanced permissions, audit logs

DocsIt - Empowering everyone to create beautiful documentation, completely free and open source.

Made with ❤️ by the open source community.

Hierarchical document structure (parent-child relationships)
Soft delete (archive) with restore functionality# ================================================
Full CRUD operations with optimistic updates# Appwrite Storage Configuration (for file uploads)

================================================

Editor# Storage Bucket ID for file uploads

Rich text editor with BlockNote# You need to create this bucket in Appwrite Console > Storage
Supports formatting, lists, headings, and more# Recommended name: "cover-images"
Auto-save functionalityNEXT_PUBLIC_APPWRITE_STORAGE_BUCKET_ID=cover-images

```

Search

Global search across all documents### 4. Set up Appwrite Storage
Keyboard shortcut (Ctrl+K) for quick access
Real-time filteringCreate a storage bucket for file uploads:

Go to your Appwrite Console

🎨 Customization2. Navigate to Storage

Click Create Bucket

Theming4. Use bucket ID: `cover-images`

The app uses next-themes with Tailwind CSS. Modify tailwind.config.ts to customize colors and styles.5. Set appropriate permissions for file uploads

Update your .env.local with the bucket ID

Components

UI components are built with Radix UI and styled with Tailwind CSS. Find them in components/ui/.### 5. Set up Appwrite Database

🚢 DeploymentFollow the detailed instructions in APPWRITE_SETUP.md to:

Create a database

Vercel (Recommended)- Create the documents collection

Push your code to GitHub- Set up attributes and indexes
Connect your repository to Vercel- Configure permissions
Add environment variables in Vercel dashboard
Deploy automatically### 6. Run the development server

Other Platforms```bash

The app works on any platform that supports Next.js:npm run dev

Netlify```
Railway
DigitalOcean App PlatformOpen http://localhost:3000 in your browser.
etc.

📚 Project Structure

🤝 Contributing

```

Fork the repositorynotion-clone/
Create a feature branch (git checkout -b feature/amazing-feature)├── app/
Commit your changes (git commit -m 'Add amazing feature')│ ├── (main)/ # Authenticated routes
Push to the branch (git push origin feature/amazing-feature)│ │ ├── _components/ # Main app components
Open a Pull Request│ │ └── (routes)/ # Document routes

│ ├── (marketing)/ # Landing page

📝 License│ ├── (public)/ # Public preview routes

│ └── layout.tsx # Root layout

This project is licensed under the MIT License. See the LICENSE file for details.├── components/

│ ├── modals/ # Modal components

🙏 Acknowledgments│ ├── providers/ # Context providers

│ └── ui/ # UI components

Next.js - React framework├── lib/
Appwrite - Backend-as-a-Service│ ├── appwrite.ts # Appwrite client
BlockNote - Rich text editor│ ├── appwrite-documents.ts # Document CRUD operations
Tailwind CSS - CSS framework│ ├── appwrite-storage.ts # File upload/storage helpers
Radix UI - UI primitives│ └── utils.ts # Utilities

└── public/ # Static assets

🆘 Support```

If you encounter any issues:## 🔑 Key Features Explained

Check that all environment variables are correctly set
Verify Appwrite project configuration### Authentication
Ensure proper permissions are set on database collections and storage buckets- Email/password authentication powered by Appwrite
Custom auth context (useAuth) for managing user state

---- Protected routes with automatic redirects

Happy coding! 🚀### Document Management

Hierarchical document structure (parent-child relationships)
Soft delete (archive) with restore functionality
Full CRUD operations with optimistic updates

Editor

Rich text editor with BlockNote
Supports formatting, lists, headings, and more
Auto-save functionality

Search

Global search across all documents
Keyboard shortcut (Ctrl+K) for quick access
Real-time filtering

🎨 Customization

Theming

The app uses next-themes with Tailwind CSS. Modify tailwind.config.ts to customize colors and styles.

Components

UI components are built with Radix UI and styled with Tailwind CSS. Find them in components/ui/.

🚢 Deployment

Vercel (Recommended)

Push your code to GitHub
Import your repository in Vercel
Add environment variables
Deploy!

Other Platforms

The app can be deployed to any platform that supports Next.js 13:

Netlify
Railway
AWS Amplify
Self-hosted with Docker

📖 Documentation

Migration Guide - Details about the Convex to Appwrite migration
Appwrite Setup - Step-by-step Appwrite configuration

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

⚠️ Known Issues

TypeScript errors during development are normal until the first build completes
Make sure to set up Appwrite database before running the app

🆘 Support

If you encounter any issues:

Check the APPWRITE_SETUP.md guide
Verify all environment variables are set correctly
Ensure Appwrite database and collection are properly configured

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
app		app
components		components
lib		lib
public		public
scripts		scripts
.env.local.example		.env.local.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
README.md		README.md
components.json		components.json
next.config.js		next.config.js
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
tailwind.config.ts		tailwind.config.ts
tsconfig.json		tsconfig.json

Happyesss/DocsIt

Folders and files

Latest commit

History

Repository files navigation

DocsIt - Free & Open Source AI-Powered Documentation Platform

🌟 What DocsIt Does

🆓 Completely Free & Open Source

🚀 Key Features

🤖 AI-Powered Intelligence

📝 Rich Editing Experience

🔄 Real-Time Collaboration

🗂️ Smart Organization

🔐 Security & Privacy

🛠️ Tech Stack

🚀 Quick Start

Prerequisites

1. Clone the Repository

2. Install Dependencies

3. Environment Setup

4. Appwrite Setup

5. Run the Development Server

📚 Project Structure

🎯 Use Cases

For Development Teams

For Product Teams

For Content Teams

🤝 Contributing

Ways to Contribute

Development Setup

📄 License

🌍 Community & Support

🚀 Deployment

Deploy on Vercel (Recommended)

Self-Hosting Options

🔮 Roadmap

================================================

Editor# Storage Bucket ID for file uploads

Search

🎨 Customization2. Navigate to Storage

Theming4. Use bucket ID: cover-images

Components

🚢 DeploymentFollow the detailed instructions in APPWRITE_SETUP.md to:

Vercel (Recommended)- Create the documents collection

Other Platforms```bash

📚 Project Structure

🤝 Contributing

📝 License│ ├── (public)/ # Public preview routes

🙏 Acknowledgments│ ├── providers/ # Context providers

🆘 Support```

Editor

Search

🎨 Customization

Theming

Components

🚢 Deployment

Vercel (Recommended)

Other Platforms

📖 Documentation

🤝 Contributing

📝 License

🙏 Acknowledgments

⚠️ Known Issues

🆘 Support

🔮 Future Enhancements

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Theming4. Use bucket ID: `cover-images`

Packages