Download the PHP package itech-world/sulu-wiki-bundle without Composer
On this page you can find all versions of the php package itech-world/sulu-wiki-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download itech-world/sulu-wiki-bundle
More information about itech-world/sulu-wiki-bundle
Files in itech-world/sulu-wiki-bundle
Package sulu-wiki-bundle
Short Description SuluWikiBundle extends the Sulu CMS to offer wiki and documentation management features similar to WikiJS
License MIT
Informations about the package sulu-wiki-bundle
Wiki Bundle for Sulu
Developed by Steeven THOMAS
SuluWikiBundle extends the Sulu CMS to offer wiki and documentation management features similar to WikiJS
📂 Requirements
- PHP ^8.2
- Sulu ^2.6.*
🛠️ Features
- Wiki and Documentation Management
- Syntax Highlighting for Code Blocks
- Keyboard Shortcuts
- Copy Button
- Quotes
- Separators
📸 Screenshots
You can see screenshots of admin and frontend.
🚀 Installation
Step 1: Download using composer
In a Symfony application run this command to install and integrate Cookie Consent bundle in your application:
Step 2: Enable the bundle
When not using symfony flex, enable the bundle in bundles.php manually:
Step 3: Edit admin package
Edit the assets/admin/package.json
to add the bundle to the list of bundles:
Edit the assets/admin/app.js
to add the bundle in imports:
In the assets/admin/
folder, run the following command:
or
Step 4: Configure to your needs
Configure your bundle in the config/packages/itech_world_sulu_wiki.yaml
file:
You can find all urls in https://cdnjs.com/libraries/highlight.js By default :
- stylesheet: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/atom-one-dark.min.css"
- script: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"
- languages: ["https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/php.min.js"]
For the quote icons, you can use any emoji you want or add external icons, from FontAwesome for example.
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 file.
📖 Usage
Twig implementation
Load the HIGHLIGHT scripts and stylesheet in your base twig template in the head
section:
If you want to use the default front css, load it in your base twig template in the head
section:
Include the blocks in your twig front template:
🎨 Customization
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 template.
🐛 Bug and Idea
See the open issues for a list of proposed features (and known issues).
💰 Support me
You can buy me a coffee to support me this plugin is 100% free.
👨💻 Contact
📘 License
This bundle is under the MIT License.