PHPackages                             itech-world/sulu-wiki-bundle - 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. [Framework](/categories/framework)
4. /
5. itech-world/sulu-wiki-bundle

ActiveSulu-bundle[Framework](/categories/framework)

itech-world/sulu-wiki-bundle
============================

SuluWikiBundle extends the Sulu CMS to offer wiki and documentation management features similar to WikiJS

1.0.0(1y ago)721MITPHPPHP ^8.2

Since Jan 20Pushed 1y ago2 watchersCompare

[ Source](https://github.com/steeven-th/SuluWikiBundle)[ Packagist](https://packagist.org/packages/itech-world/sulu-wiki-bundle)[ RSS](/packages/itech-world-sulu-wiki-bundle/feed)WikiDiscussions main Synced today

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

 [![Itech World logo](./doc/images/logo.png)](./doc/images/logo.png)

Wiki Bundle for [Sulu](https://sulu.io)
=======================================

[](#wiki-bundle-for-sulu)

### Developed by [Steeven THOMAS](https://github.com/steeven-th)

[](#developed-by-steeven-thomas)

 [ ![GitHub license](https://camo.githubusercontent.com/f8df3091bbe1149f398a5369b2c39e896766f9f6efba3477c63e9b4aa940ef14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e) ](LICENSE) [ ![GitHub tag (latest SemVer)](https://camo.githubusercontent.com/970a6d0e0a95b76faf8614dc3d40243534cd4c476fdcd03fa572fff2dd4b187f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f72656c656173652d76312e302e302d626c7565) ](https://github.com/steeven-th/SuluWikiBundle/releases) [ ![Sulu compatibility](https://camo.githubusercontent.com/5e40a4a0336f4cb4f6759d91d8a51a77f0d6ad6f154d6ad8d298451e9a216f31/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73756c755f636f6d7061746962696c6974792d2533453d322e362d6379616e) ](https://sulu.io/)

SuluWikiBundle extends the Sulu CMS to offer wiki and documentation management features similar to WikiJS 📂 Requirements
--------------

[](#-requirements)

- PHP ^8.2
- Sulu ^2.6.\*

🛠️ Features
-----------

[](#️-features)

- Wiki and Documentation Management
- Syntax Highlighting for Code Blocks
- Keyboard Shortcuts
- Copy Button
- Quotes
- Separators

📸 Screenshots
-------------

[](#-screenshots)

You can see [screenshots](./doc/screenshots.md) of admin and frontend.

🚀 Installation
--------------

[](#-installation)

### Step 1: Download using composer

[](#step-1-download-using-composer)

In a Symfony application run this command to install and integrate Cookie Consent bundle in your application:

```
composer require itech-world/sulu-wiki-bundle
```

### Step 2: Enable the bundle

[](#step-2-enable-the-bundle)

When not using symfony flex, enable the bundle in bundles.php manually:

```
return [
    // ...
    ItechWorld\SuluWikiBundle\ItechWorldSuluWikiBundle::class => ['all' => true],
];
```

### Step 3: Edit admin package

[](#step-3-edit-admin-package)

Edit the `assets/admin/package.json` to add the bundle to the list of bundles:

```
{
    "dependencies": {
        "sulu-itech-world-sulu-wiki-bundle": "file:../../vendor/itech-world/sulu-wiki-bundle/public/js"
    }
}
```

Edit the `assets/admin/app.js` to add the bundle in imports:

```
import 'sulu-itech-world-sulu-wiki-bundle';
```

In the `assets/admin/` folder, run the following command:

```
npm install
npm run build
```

or

```
yarn install
yarn build
```

### Step 4: Configure to your needs

[](#step-4-configure-to-your-needs)

Configure your bundle in the `config/packages/itech_world_sulu_wiki.yaml` file:

```
itech_world_sulu_wiki:
    highlight:
        stylesheet: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/atom-one-dark.min.css" # Define the url of the stylesheet for theme highlight.js, 11.10.0 by default
        script: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js'" # Define the url of the script for highlight.js, 11.9.0 by default
        languages: ["https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/php.min.js"] # Define the urls of the scripts for the languages you want to use, 11.9.0/languages/php.min.js by default
        copy_button: true # Define if you want to display the copy button, true by default
    quote:
        standard: "💬" # Define the standard quote icon
        info: "ℹ️" # Define the info quote icon
        warning: "⚠️" # Define the warning quote icon
        danger: "❗" # Define the danger quote icon
        success: "✅" # Define the success quote icon
```

You can find all urls in By default :

- stylesheet: ""
- script: ""
- languages: \[""\]

For the quote icons, you can use any emoji you want or add external icons, from [FontAwesome](https://fontawesome.com/) for example.

### Step 5: Add blocks in your xml page template

[](#step-5-add-blocks-in-your-xml-page-template)

Add the following code in your xml page template:

```

```

You can create and use your own block template, like the [blocks.xml](./config/templates/blocks.xml) file.

📖 Usage
-------

[](#-usage)

### Twig implementation

[](#twig-implementation)

Load the HIGHLIGHT scripts and stylesheet in your base twig template in the `head` section:

```
{{ it_sulu_wiki_scripts() }}
```

If you want to use the default front css, load it in your base twig template in the `head` section:

```
{{ it_sulu_wiki_default_css() }}
```

Include the blocks in your twig front template:

```
{% include '@ItechWorldSuluWiki/blocks/_blocks.html.twig' %}
```

🎨 Customization
---------------

[](#-customization)

### Styling

[](#styling)

SuluWikiBundle comes with a default styling. If you don't want to use the default css, you can create your own css file. You can find the default css file in the bundle [default\_css.html.twig](./templates/default_css.html.twig) template.

🐛 Bug and Idea
--------------

[](#-bug-and-idea)

See the [open issues](https://github.com/steeven-th/SuluWikiBundle/issues) for a list of proposed features (and known issues).

💰 Support me
------------

[](#-support-me)

You can buy me a coffee to support me **this plugin is 100% free**.

[Buy me a coffee](https://www.buymeacoffee.com/steeven.th)

👨‍💻 Contact
-----------

[](#‍-contact)

[![](https://avatars.githubusercontent.com/u/82022828?s=96&v=4)](https://steeven-th.dev)[![](https://camo.githubusercontent.com/40e342fa30b2f021074afbc36aefbd55ebc5a60d37c2210bf74f39b6a494f9da/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f7468756d622f322f32642f547769747465725f582e706e672f36343070782d547769747465725f582e706e67)](https://x.com/ThomasSteeven2)

📘 License
---------

[](#-license)

This bundle is under the [MIT License](LICENSE).

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity51

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

Unknown

Total

1

Last Release

529d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/15d31371355db522b06ffd73f8be76e32972f145390b1eba33b190c7fd412413?d=identicon)[steeven-th](/maintainers/steeven-th)

---

Top Contributors

[![steeven-th](https://avatars.githubusercontent.com/u/82022828?v=4)](https://github.com/steeven-th "steeven-th (6 commits)")

---

Tags

phpsymfonydocumentationsymfony-uxcmswikisuluContent management system

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/itech-world-sulu-wiki-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/itech-world-sulu-wiki-bundle/health.svg)](https://phpackages.com/packages/itech-world-sulu-wiki-bundle)
```

###  Alternatives

[sulu/skeleton

Project template for starting your new project based on the Sulu content management system

29735.5k](/packages/sulu-skeleton)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.4M203](/packages/sulu-sulu)[forkcms/forkcms

Fork is an open source CMS that will rock your world.

1.2k45.5k](/packages/forkcms-forkcms)[kompo/kompo

Laravel &amp; Vue.js FullStack Components for Rapid Application Development

12014.8k49](/packages/kompo-kompo)[luyadev/luya-module-cms

The LUYA CMS module provides a full functional Content Management System for adding contents based on blocks.

32180.1k18](/packages/luyadev-luya-module-cms)[impresscms/impresscms

ImpressCMS is an open source content management system with a focus on security and speed

291.1k](/packages/impresscms-impresscms)

PHPackages © 2026

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