vulcandigital/silverstripe-userdocs

A module for creating user documentation

1.0.0-beta2 2018-02-15 09:28 UTC

Requires

• silverstripe/recipe-cms: ^1
• sunra/php-simple-html-dom-parser: ^1.5.2
• symbiote/silverstripe-gridfieldextensions: ^3

Requires (Dev)

• phpunit/phpunit: ^5.7
• squizlabs/php_codesniffer: 3.*

Suggests

• vulcandigital/silverstripe-pagefeedback: This module allows you to receive feedback on specific pages of your documentation

BSD-3-Clause

• Reece Alexander

README

silverstripe-userdocs

Create your own user documentation easily for anything! Especially that custom API you made that people need to know how to use, wouldn't it be great to easily document all endpoints, request and response parameters, display beautifully highlighted JSON/XML response examples, code blocks and more.

Requirements

• silverstripe/cms: "^4.0"

Installation

Installation is only supported via composer:

composer require vulcandigital/silverstripe-userdocs

Documentation

You can find detailed documentation here

• Getting Started
• Shortcodes
• Code Tabs

License

BSD-3-Clause - Vulcan Digital Ltd

Preview

A beautiful preview in effect for one of our SaaS products