PHPackages                             vulcandigital/silverstripe-userdocs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. vulcandigital/silverstripe-userdocs

ActiveSilverstripe-vendormodule[Utility & Helpers](/categories/utility)

vulcandigital/silverstripe-userdocs
===================================

A module for creating user documentation

1.0.0-beta2(8y ago)353BSD-3-ClausePHP

Since Feb 12Pushed 8y ago1 watchersCompare

[ Source](https://github.com/vulcandigital/silverstripe-userdocs)[ Packagist](https://packagist.org/packages/vulcandigital/silverstripe-userdocs)[ RSS](/packages/vulcandigital-silverstripe-userdocs/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (2)Dependencies (5)Versions (2)Used By (0)

[![Build Status](https://camo.githubusercontent.com/aa142209fc6377d5cac8904f68eb0cc06c51ac488d2f16f670584072b6eb054c/68747470733a2f2f7472617669732d63692e6f72672f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/vulcandigital/silverstripe-userdocs) [![codecov](https://camo.githubusercontent.com/aba002d63dd132e2951367f9e6775dbd9a60898f42ce556743a38a7d4e2289d6/68747470733a2f2f636f6465636f762e696f2f67682f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/vulcandigital/silverstripe-userdocs) [![Latest Stable Version](https://camo.githubusercontent.com/ff583dcfa962e5ad613832d0756d31e7f6ce1f9edcb366de593eeaf4a2c2e3af/68747470733a2f2f706f7365722e707567782e6f72672f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732f762f737461626c65)](https://packagist.org/packages/vulcandigital/silverstripe-userdocs) [![Total Downloads](https://camo.githubusercontent.com/6bd8359d35a42ecddf08d4d70500611a87e8e1e022b39ecc1043d7d877daadd4/68747470733a2f2f706f7365722e707567782e6f72672f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732f646f776e6c6f616473)](https://packagist.org/packages/vulcandigital/silverstripe-userdocs) [![Latest Unstable Version](https://camo.githubusercontent.com/d76c2f693a43a0cdc0d5a1996434fb12fa787756349a46dc1f7c0cbc99cb387d/68747470733a2f2f706f7365722e707567782e6f72672f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732f762f756e737461626c65)](https://packagist.org/packages/vulcandigital/silverstripe-userdocs) [![License](https://camo.githubusercontent.com/597872d3bd4e862ca5cdefbcc8e5b4228be88047c237f43adf81ac54f0ec8e32/68747470733a2f2f706f7365722e707567782e6f72672f76756c63616e6469676974616c2f73696c7665727374726970652d75736572646f63732f6c6963656e7365)](https://packagist.org/packages/vulcandigital/silverstripe-userdocs)

silverstripe-userdocs
=====================

[](#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
------------

[](#requirements)

- silverstripe/cms: "^4.0"

Installation
------------

[](#installation)

Installation is *only* supported via composer:

```
composer require vulcandigital/silverstripe-userdocs
```

Documentation
-------------

[](#documentation)

You can find detailed documentation [here](docs)

- [Getting Started](docs/en/GettingStarted.md)
- [Shortcodes](docs/en/Shortcodes.md)
- [Code Tabs](docs/en/CodeTabs.md)

License
-------

[](#license)

[BSD-3-Clause](LICENSE.md) - [Vulcan Digital Ltd](https://vulcandigital.co.nz)

Preview
-------

[](#preview)

A beautiful preview in effect for one of our SaaS products

[![Preview](https://camo.githubusercontent.com/d46b9b63c137372214945ad603c5285cfd398413264c02dcb30b7514edbebd73/68747470733a2f2f692e696d6775722e636f6d2f4b5161796845552e706e67)](https://camo.githubusercontent.com/d46b9b63c137372214945ad603c5285cfd398413264c02dcb30b7514edbebd73/68747470733a2f2f692e696d6775722e636f6d2f4b5161796845552e706e67)

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

2

Last Release

3010d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/79352f13e05702b6ba2a9e27508d7cbd72e902342ff4e6608861b40a7cab5644?d=identicon)[vulcandigital](/maintainers/vulcandigital)

---

Top Contributors

[![zanderwar](https://avatars.githubusercontent.com/u/13566916?v=4)](https://github.com/zanderwar "zanderwar (25 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/vulcandigital-silverstripe-userdocs/health.svg)

```
[![Health](https://phpackages.com/badges/vulcandigital-silverstripe-userdocs/health.svg)](https://phpackages.com/packages/vulcandigital-silverstripe-userdocs)
```

###  Alternatives

[silverstripe/userforms

UserForms enables CMS users to create dynamic forms via a drag and drop interface and without getting involved in any PHP code

1321.0M72](/packages/silverstripe-userforms)[heyday/silverstripe-menumanager

Allows complex menu management to be handled through the CMS when a simple tree structure is not enough.

36304.4k7](/packages/heyday-silverstripe-menumanager)[dynamic/silverstripe-locator

SilverStripe Locator Module. Show locations on a map. Search by geoposition.

2113.2k1](/packages/dynamic-silverstripe-locator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)