It's Your Doc

Features

Our documentation system is built with modern CCMS principles and includes powerful features for creating professional technical documentation.

Core Features

Markdown-Based Content

Write documentation in GitHub Flavored Markdown with support for:

  • Headers (H1-H6)
  • Bold and italic text
  • Lists (ordered and unordered)
  • Links: internal and external
  • Code blocks with syntax highlighting
  • Tables
  • Blockquotes
  • Task lists
  • Strikethrough text

Reusable Components

Create reusable snippets that can be included anywhere:

  • Product names and version numbers
  • Common procedures
  • Legal disclaimers
  • Installation steps
  • Configuration blocks

Shortcode System

Built-in shortcodes for styled callouts:

SEO Optimization

Every page includes:

  • Custom title tags
  • Meta descriptions
  • Open Graph tags for social sharing
  • Twitter Card metadata
  • Canonical URLs
  • Semantic HTML structure
  • Clean, readable URLs
  • Breadcrumbs: Automatically generated from URL structure
  • Table of Contents: Auto-extracted from H2 and H3 headers
  • Internal Linking: Simple relative paths between pages
  • Sticky TOC: Sidebar navigation follows scroll

Customizable Branding

Configure via .env:

  • Custom brand name
  • Logo upload support
  • Configurable color scheme (11 color variables)
  • Consistent theming across all pages

Version Control Ready

  • All content stored as plain text .md files
  • Perfect for Git workflows
  • Track changes, review via pull requests
  • Branch for different versions
  • Rollback capabilities

Performance

  • No database required: File-based storage
  • On-the-fly rendering: No pre-compilation needed
  • Fast load times: Minimal overhead
  • Cacheable: Can add caching layer if needed

Responsive Design

  • Mobile-friendly layout
  • Collapsible table of contents on small screens
  • Readable on all device sizes
  • Touch-friendly navigation

Security

  • Directory traversal protection
  • HTML input stripping
  • Unsafe link blocking
  • Path sanitization
  • No authentication required for public docs

Technical Stack

  • Laravel Framework: Robust PHP foundation
  • league/commonmark: Industry-standard Markdown parser
  • GitHub Flavored Markdown: Extended syntax support
  • Blade Templates: Flexible view layer
  • CSS Custom Properties: Dynamic theming

Extensibility

The system is designed for easy customization:

  • Add custom shortcodes
  • Integrate search functionality
  • Implement version switching
  • Add PDF export
  • Connect to external APIs
  • Add authentication if needed

Coming Soon

Future enhancements may include:

  • Full-text search
  • Multi-language support
  • PDF generation
  • Version selector
  • Dark mode
  • Syntax highlighting for more languages
  • Interactive code examples
×