PHPackages                             craftconvert/sw6-project-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. craftconvert/sw6-project-documentation

ActiveShopware-platform-plugin

craftconvert/sw6-project-documentation
======================================

Craft Convert: Project Documentation

1.2.0(3mo ago)0262↓50%proprietaryJavaScriptPHP >=8.2

Since Jan 23Pushed 3mo agoCompare

[ Source](https://github.com/craftconvert/sw6-project-documentation)[ Packagist](https://packagist.org/packages/craftconvert/sw6-project-documentation)[ RSS](/packages/craftconvert-sw6-project-documentation/feed)WikiDiscussions main Synced 1mo ago

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

Craft Convert Project Documentation
===================================

[](#craft-convert-project-documentation)

A Shopware 6 plugin that provides an integrated documentation portal within the administration panel. Write documentation in Markdown files, and the plugin renders them with sidebar navigation, search, and table of contents.

Features
--------

[](#features)

- Markdown-based documentation stored alongside code
- Sidebar navigation with collapsible sections
- Full-text search across all documents
- Auto-generated table of contents with scroll spy
- Multi-language support (locale-based folders)
- Previous/Next page navigation
- Mobile-responsive layout
- ACL-protected access
- Multi-plugin support (other plugins can contribute docs)

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

[](#installation)

```
lando php bin/console plugin:refresh
lando php bin/console plugin:install --activate CraftConvertProjectDocumentation
lando php bin/console assets:install
lando php bin/console theme:compile
lando php bin/console cache:clear
```

Access Control
--------------

[](#access-control)

Users need the `cc_project_documentation.viewer` privilege to access the documentation portal.

Assign this in: **Settings > Users & permissions > Roles > \[Role\] > Additional permissions**

Documentation Sources
---------------------

[](#documentation-sources)

The plugin supports two documentation sources:

1. **Project documentation** - General project docs stored in a configured folder
2. **Plugin documentation** - Each plugin can contribute its own docs

### Project Documentation

[](#project-documentation)

Store general project documentation in a dedicated folder outside of plugins. By default, the plugin looks for docs in:

```
custom/docs/project/{locale}/

```

You can customize this path by creating `config/packages/cc_project_documentation.yaml`:

```
parameters:
    cc.project_documentation.sets:
        project:
            label: 'Project'
            icon: 'regular-book-user'
            paths:
                - '%kernel.project_dir%/custom/docs/project'
```

You can also define multiple documentation sets (e.g., for different audiences):

```
parameters:
    cc.project_documentation.sets:
        project:
            label: 'Project'
            icon: 'regular-book-user'
            paths:
                - '%kernel.project_dir%/custom/docs/project'
        developer:
            label: 'Developer'
            icon: 'regular-code'
            paths:
                - '%kernel.project_dir%/custom/docs/developer'
```

### Plugin Documentation

[](#plugin-documentation)

Any plugin can contribute documentation by adding a `Resources/docs/{locale}/` folder.

### Directory Structure

[](#directory-structure)

```
YourPlugin/
└── src/
    └── Resources/
        └── docs/
            ├── en-GB/
            │   ├── _sidebar.json
            │   ├── getting-started.md
            │   └── features/
            │       └── overview.md
            └── nl-BE/
                ├── _sidebar.json
                └── ...

```

### Sidebar Configuration

[](#sidebar-configuration)

Create a `_sidebar.json` file to define the navigation:

```
{
    "label": "Your Plugin",
    "icon": "regular-puzzle",
    "position": 50,
    "items": [
        {
            "path": "getting-started",
            "label": "Getting Started"
        },
        {
            "label": "Features",
            "children": [
                {
                    "path": "features/overview",
                    "label": "Overview"
                }
            ]
        }
    ]
}
```

PropertyDescription`label`Section name displayed in the sidebar`icon`Shopware icon name (e.g., `regular-book`)`position`Sort order (lower numbers appear first)`items`Array of navigation items`path`Relative path to `.md` file (without extension)`children`Nested items for collapsible subsections### Position Guidelines

[](#position-guidelines)

RangePurpose0-9Welcome/Introduction10-29Core integrations30-49Theme and major features50-79Feature plugins80-99Utility plugins100+Minor plugins### Markdown Syntax

[](#markdown-syntax)

Standard Markdown is supported:

```
# Page Title

## Section Heading

Paragraph text with **bold** and *italic*.

- Unordered list
- Another item

1. Ordered list
2. Second item

[Link text](https://example.com)

`inline code`

​```php
// Code block
$example = true;
​```

| Column 1 | Column 2 |
|----------|----------|
| Data     | Data     |

> Blockquote
```

### Images

[](#images)

Basic images use standard Markdown syntax:

```
![Alt text](images/example.png)
```

#### Image Storage

[](#image-storage)

Images can be stored in two locations:

1. **Locale-specific** (checked first):

    ```
    Resources/docs/{set}/{locale}/images/screenshot.png

    ```
2. **Language-independent** (fallback):

    ```
    Resources/docs/{set}/images/screenshot.png

    ```

Use the language-independent folder to avoid duplicating images across locales.

### Screenshots with Browser Frame

[](#screenshots-with-browser-frame)

Wrap images in a `` tag to display them in a browser-style frame with traffic lights and URL bar:

```

![Checkout page](images/checkout.png)

```

#### Screenshot Attributes

[](#screenshot-attributes)

AttributeDescriptionExample`url`URL displayed in the browser bar`url="https://example.com"``scroll`Enable scrolling for tall screenshots`scroll``height`Container height when scrolling (default: 300px)`height="400px"``ratio`Aspect ratio for responsive sizing`ratio="16/9"`#### Examples

[](#examples)

**Static screenshot:**

```

![Order list](images/order-list.png)

```

**Scrollable screenshot:**

```

![Full checkout page](images/checkout-full.png)

```

**Fixed aspect ratio:**

```

![Dashboard](images/dashboard.png)

```

### Caching

[](#caching)

Documentation is cached for 1 hour. Clear the cache after making changes:

```
lando php bin/console cache:clear
```

API Endpoints
-------------

[](#api-endpoints)

All endpoints require `cc_project_documentation:read` ACL permission.

EndpointDescription`GET /api/_action/cc/project-documentation/tree?locale=en-GB`Navigation tree`GET /api/_action/cc/project-documentation/document/{path}?locale=en-GB`Document content`GET /api/_action/cc/project-documentation/search?locale=en-GB&query=term`Search documentsTroubleshooting
---------------

[](#troubleshooting)

**Menu not visible**: Ensure plugin is active and user has the `cc_project_documentation.viewer` privilege.

**Documents not appearing**: Check that `_sidebar.json` paths match your markdown files and clear the cache.

**Changes not showing**: Clear cache after modifying documentation or rebuild admin assets after JS/SCSS changes.

###  Health Score

42

—

FairBetter than 89% of packages

Maintenance86

Actively maintained with recent releases

Popularity16

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

5

Last Release

100d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/256880806?v=4)[Craft Convert](/maintainers/craftconvert)[@craftconvert](https://github.com/craftconvert)

---

Top Contributors

[![olicauwenbergh](https://avatars.githubusercontent.com/u/3197883?v=4)](https://github.com/olicauwenbergh "olicauwenbergh (22 commits)")

### Embed Badge

![Health badge](/badges/craftconvert-sw6-project-documentation/health.svg)

```
[![Health](https://phpackages.com/badges/craftconvert-sw6-project-documentation/health.svg)](https://phpackages.com/packages/craftconvert-sw6-project-documentation)
```

###  Alternatives

[shopware/production

178190.0k](/packages/shopware-production)[shopware/storefront

Storefront for Shopware

684.2M147](/packages/shopware-storefront)[kiener/mollie-payments-plugin

Mollie Payments

6257.6k](/packages/kiener-mollie-payments-plugin)[shopware/administration

Administration frontend for the Shopware Core

413.9M74](/packages/shopware-administration)[frosh/tools

Provides some basic things for managing the Shopware Installation

79709.7k2](/packages/frosh-tools)[shopware/elasticsearch

Elasticsearch for Shopware

153.6M8](/packages/shopware-elasticsearch)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)