Contensio logo

Knowledge Base

A clean, beautiful documentation and help center for your Contensio CMS site. Organize content into collections, categories, and articles with a sidebar navigation inspired by the best documentation s

About this plugin

Knowledge Base - Contensio Plugin

A clean, beautiful documentation and help center for your Contensio site. Organize content into collections, categories, and articles with a sidebar navigation inspired by the best documentation sites.

Features

  • Three-level hierarchy - Collections > Categories > Articles
  • Multilingual - each article, category, and collection has translated title, summary, and body per language; forms show one tab per active language
  • Beautiful frontend - cream/ink/ember editorial palette, sticky sidebar navigation, prev/next article navigation, breadcrumb trail
  • Configurable URL prefix - set the base URL (default: /help)
  • Article options - featured flag, active/inactive status, sort order
  • Clean admin - grid-based collection overview, drill-down to categories and articles, breadcrumb navigation in admin

Requirements

  • Contensio CMS

Installation

  1. Require the package:

    composer require contensio/plugin-knowledge-base

  2. Run migrations:

    php artisan migrate

  3. The plugin registers itself automatically via the Contensio plugin system.

Structure

Collections
  - Getting Started
    - Categories
      - Installation
        - Articles
          - System requirements
          - Installing via Composer
          - ...
      - Configuration
        - Articles
          - ...
  - ...

Multilingual support

If your site has multiple active languages (configured in the CMS language settings), each content form shows a language tab per language. The title and body are stored per language code in the contensio_kb_translations table.

On the frontend, the current request locale (app()->getLocale()) determines which translation is loaded. If no translation exists for the current locale, the plugin falls back to the default language, then to any available translation.

URL structure

Page URL
Home /{prefix}
Collection /{prefix}/{collection-slug}
Category /{prefix}/{collection-slug}/{category-slug}
Article /{prefix}/{collection-slug}/{category-slug}/{article-slug}

The prefix defaults to help and can be changed in the plugin settings.

Data storage

Table Description
contensio_kb_collections Top-level groupings: slug, icon, color, sort order
contensio_kb_categories Sections within a collection
contensio_kb_articles Individual articles within a category
contensio_kb_translations Multilingual title, summary, and body per record

License

AGPL-3.0-or-later. See LICENSE.