vulcandigital / silverstripe-userdocs
A module for creating user documentation
Installs: 5
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 3
Open Issues: 0
Type:silverstripe-vendormodule
Requires
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
This package is auto-updated.
Last update: 2024-10-18 20:22:26 UTC
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
License
BSD-3-Clause - Vulcan Digital Ltd
Preview
A beautiful preview in effect for one of our SaaS products