It's Your Doc

It's Your Doc

It's Your Doc is a lightweight Component Content Management System (CCMS) for creating beautiful, organized documentation. Built with Laravel and powered by CommonMark, it provides a simple yet powerful way to manage your documentation using Markdown files.

Why It's Your Doc?

  • Simple: Write documentation in Markdown, deploy instantly
  • Fast: No database required, lightning-fast page loads
  • Customizable: Full control over colors, branding, and layout
  • Single-Source: Reusable content components eliminate duplication
  • SEO-Friendly: Automatic meta tags, Open Graph, and semantic HTML
  • Version Control: All docs stored in Git for complete change tracking
  • Responsive: Beautiful on desktop, tablet, and mobile

Key Features

Markdown-Powered

Write documentation in plain Markdown with GitHub Flavored Markdown support:

  • Tables with alignment
  • Syntax-highlighted code blocks
  • Task lists
  • Automatic link detection
  • And more!

Reusable Components

Create content once, include it everywhere. For example, these system requirements are stored in one file and can be included on any page:

System Requirements

  • PHP 8.2 or higher
  • MySQL 8.0+ or PostgreSQL 13+
  • Composer 2.x
  • Node.js 18+ and NPM
  • 2GB RAM minimum
  • 10GB disk space

The syntax is: {{ include:your-file-name }} (without the space) to include content from resources/docs/includes/.

Perfect for maintaining consistency across multiple documentation pages.

Custom Shortcodes

Add styled callouts and alerts with simple shortcode syntax:

<div class="info">This is helpful information for your readers</div>
<div class="warning">Pay careful attention to this important detail</div>
<div class="tip">Here&#039;s a pro tip to make your life easier</div>
<div class="note">Additional context and references</div>

Full Customization

Customize every aspect through environment variables:

  • Branding: Logo, company name, colors
  • Contact Info: Support email and phone
  • Theme: Complete color customization
  • Layout: Three-column responsive layout

Auto-Generated Features

  • Table of Contents: Automatically extracted from H2/H3 headers
  • Breadcrumbs: Navigation trails based on URL structure
  • Anchor Links: Deep linking to any heading
  • Image Lightbox: Click images for full-size view

Perfect For

  • Product documentation
  • API references
  • Knowledge bases
  • Internal wikis
  • User guides
  • Technical tutorials
  • Team handbooks

Quick Example

Create a documentation page in minutes:

File: resources/docs/api-overview.md

---
title: API Overview
description: Getting started with our REST API
---

# API Overview

Our API provides programmatic access to all platform features.

## Authentication

All API requests must include an authentication header:

```bash
Authorization: Bearer YOUR_API_TOKEN

You can generate tokens in your account settings.

Rate Limits

  • 1000 requests per hour for authenticated users
  • 100 requests per hour for anonymous users

Endpoints

See the complete API Reference for all available endpoints.


Access it at: `/docs/api-overview`

## Getting Started

Ready to create your documentation? Follow these steps:

1. **[Installation](getting-started)** - Clone and set up It's Your Doc
2. **[Customization](customization)** - Add your branding and colors
3. **[Writing Content](writing-content)** - Learn Markdown basics and features
4. **[File Structure](file-structure)** - Organize your documentation

## Live Example

You're reading it! This entire documentation site is built with It's Your Doc, demonstrating all the features and capabilities.

## Open Source

It's Your Doc is open source and can be fully customized to match your needs. Clone it, modify it, and make it yours!

<div class="tip">Check out the [Getting Started](getting-started) guide to install It&#039;s Your Doc in under 5 minutes!</div>
×