PHPackages                             magebitcom/module-documentation - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. magebitcom/module-documentation

ActiveMagento2-module[Admin Panels](/categories/admin)

magebitcom/module-documentation
===============================

Module documentation viewer for Magento 2 admin

v0.0.1(3mo ago)02MITPHPPHP ^8.1

Since Feb 10Pushed 3mo agoCompare

[ Source](https://github.com/magebitcom/magento2-documentation-module)[ Packagist](https://packagist.org/packages/magebitcom/module-documentation)[ RSS](/packages/magebitcom-module-documentation/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

Magebit Documentation Module
============================

[](#magebit-documentation-module)

A Magento 2 module that provides a centralized documentation viewer in the admin panel. View, search, and navigate module documentation.

Installation
------------

[](#installation)

### Via Composer

[](#via-composer)

```
composer require magebitcom/module-documentation
bin/magento module:enable Magebit_Documentation
bin/magento setup:upgrade
```

Requirements
------------

[](#requirements)

- PHP 8.1 or higher
- Magento 2.4+

Quick Start
-----------

[](#quick-start)

### 1. Create Documentation Files

[](#1-create-documentation-files)

Create a `Docs/` folder in your module with Markdown files:

```
app/code/Vendor/YourModule/
├── Docs/
│   ├── 1-getting-started.md
│   ├── 2-configuration.md
│   └── 3-api-reference.md
├── etc/
│   └── documentation.xml
└── ...

```

### 2. Register Documentation

[](#2-register-documentation)

Create `etc/documentation.xml` in your module:

```

```

### 3. Clear Cache

[](#3-clear-cache)

```
bin/magento cache:flush
```

### 4. View Documentation

[](#4-view-documentation)

Navigate to **System → Documentation** in the Magento admin panel.

Configuration
-------------

[](#configuration)

### Module Attributes

[](#module-attributes)

AttributeRequiredDescription`name`YesModule name (e.g., `Vendor_Module`)`title`NoDisplay title in sidebar (defaults to module name)`sortOrder`NoModule position (lower = higher, default: 100)`icon`NoPath to icon (e.g., `Vendor_Module::images/icon.svg`)### Documentation Attributes

[](#documentation-attributes)

AttributeRequiredDescription`name`YesDisplay name in sidebar`path`YesPath to documentation folder`acl`NoACL resource to restrict access`sortOrder`NoPosition within module (lower = higher, default: 100)Path Formats
------------

[](#path-formats)

### Relative Path

[](#relative-path)

```

```

Relative to the current module directory.

### Module Path (Recommended)

[](#module-path-recommended)

```

```

Format: `ModuleName::path/to/docs`

### Multiple Documentation Sections

[](#multiple-documentation-sections)

```

```

Advanced Features
-----------------

[](#advanced-features)

### ACL Protection

[](#acl-protection)

Restrict documentation visibility:

```

```

Define the ACL resource in `etc/acl.xml`:

```

```

### Custom Module Icons

[](#custom-module-icons)

Add visual branding with custom icons:

```

```

Place your SVG icon at: `view/adminhtml/web/images/module-icon.svg`

### File Naming Convention

[](#file-naming-convention)

Use numeric prefixes for ordered navigation:

```
Docs/
├── 1-introduction.md       (appears first)
├── 2-installation.md       (appears second)
├── 3-configuration.md      (appears third)
└── advanced/
    ├── 1-api.md
    └── 2-troubleshooting.md

```

Markdown Support
----------------

[](#markdown-support)

The module uses [CommonMark](https://commonmark.org/) with GitHub Flavored Markdown extensions.

### Supported Features

[](#supported-features)

- **Headers** (`#`, `##`, `###`, etc.)
- **Bold** (`**text**`) and *Italic* (`*text*`)
- **Lists** (ordered and unordered)
- **Links** (`[text](url)`)
- **Images** (`![alt](url)`)
- **Code blocks** (with syntax highlighting)
- **Tables**
- **Blockquotes** (`>`)
- **Horizontal rules** (`---`)
- **Task lists** (`- [ ]` / `- [x]`)
- **Strikethrough** (`~~text~~`)

### Example Markdown

[](#example-markdown)

```
# Getting Started

## Installation

Follow these steps:

1. Install the module
2. Enable it
3. Clear cache

## Code Example

```php
$documentation = $this->documentationProvider->getDocumentation('Vendor_Module');
```

Important Note
--------------

[](#important-note)

> Always clear cache after modifying documentation.xml

```

## API

### DocumentationProviderInterface

```php