Getting Started

A lightweight PHP-based Markdown documentation renderer.

The documentations for Uch큰 Docs is still under contruction and changes may occur as development continues.

---

Features

• Convert Markdown to responsive HTML
• Auto-generated navigation sidebar
• Clean, minimalist design
• Mobile-friendly interface
• Easy to extend and customize

Installation

1. Clone the repo: git clone https://github.com/KodoHub/UchuDocs.git
2. Run composer install to install dependencies
3. Configure your web server to point to the project directory
4. Place your Markdown files in the docs directory

Documentation Structure

docs/
├── index.md           # Home page
├── getting-started.md # Starting guide
└── topics/            # Organized by folders
    └── example.md     # Nested documentation

Creating Content

• Use .md files with standard Markdown syntax
• Files are automatically added to navigation
• Folders become navigation categories
• The page title is generated from the first heading

Customization

• Edit CSS in the template files to match your style
• Modify the layout in templates/ directory

• Configure options in the main config file:

  // Basic configuration options
  $config = [
  'title' => 'Your Documentation',
  'theme' => 'default',
  'highlightCode' => true
  ];

Advanced Usage

• Links: Reference other pages with [Link text](page-name.md)
• Images: Add to assets/images/ and reference with ![Alt](assets/images/image.png)
• Code blocks: Use triple backticks with optional language specification

Troubleshooting

• If pages don't render, check file permissions
• For styling issues, verify CSS path in templates
• Missing navigation? Ensure correct directory structure

Resources

• GitHub: https://github.com/KodoHub/UchuDocs