jonassiewertsen/statamic-documentation

A Statamic Addon to save any kind of documentation inside your control panel

v2.0.0 2024-05-22 11:35 UTC

README

Statamic 3.0+ Latest Version on Packagist

A Statamic V3 Addon to save any documentation inside your control panel.

Features

  • Documentation available in the control panel
  • Menu structure with children (max depth 2)
  • Flexible text editing with bard editor
  • Elements: Title, H2, H3, bold, italic, underlined, ordered- and unordered lists, tables, blockquotes and links
  • Videos can be embedded: Self-hosted, from YouTube or Vimeo
  • Optional video description
  • Permissions

Installation

Step 1

Pull in your package with composer

composer require jonassiewertsen/statamic-documentation

Step 2

Publish the config, collections and blueprint files:

    php artisan vendor:publish --provider="Jonassiewertsen\Documentation\ServiceProvider"

Step 3 - Enjoy

Create your first documentation page inside the control panel.

Documentation -> Manage -> Create Entry

Write something useful and save it.

Requirements

  • Statamic 4 || 5
  • Laravel 10 || 11
  • PHP >= 8.1

License

Before going into productions with Statamic Documentation, you must buy a license at the Statamic Marketplace.

Statamic Documentation is not free software.