PHPackages silverstripe/docsviewer - 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. silverstripe/docsviewer AbandonedArchivedSilverstripe-module[Utility & Helpers](/categories/utility) silverstripe/docsviewer ======================= Documentation viewer module for SilverStripe 2.0.0(7y ago)2014.2k21[5 issues](https://github.com/silverstripe/silverstripe-docsviewer/issues)[1 PRs](https://github.com/silverstripe/silverstripe-docsviewer/pulls)2BSD-3-ClausePHP Since Dec 4Pushed 3y ago14 watchersCompare [ Source](https://github.com/silverstripe/silverstripe-docsviewer)[ Packagist](https://packagist.org/packages/silverstripe/docsviewer)[ RSS](/packages/silverstripe-docsviewer/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (4)Versions (23)Used By (2) Documentation Viewer Module =========================== [](#documentation-viewer-module) ABANDONED --------- [](#abandoned) This package is abandoned. See [silverstripe/doc.silverstripe.org](https://github.com/silverstripe/doc.silverstripe.org) instead. [![Build Status](https://camo.githubusercontent.com/93f314b8101a189993a3ca366d99100b4e7e7fcbf5a201db93869a5673680128/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f73696c7665727374726970652f73696c7665727374726970652d646f63737669657765722e706e673f6272616e63683d6d6173746572)](http://travis-ci.org/silverstripe/silverstripe-docsviewer) Maintainer Contact ------------------ [](#maintainer-contact) - Will Rossiter (Nickname: willr, wrossiter) Requirements ------------ [](#requirements) These are pulled in via Composer. - SilverStripe 3.1 - [Parsedown](http://parsedown.org/) and Parsedown Extra. Summary ------- [](#summary) Reads markdown files from a given list of folders from your installation and provides a web interface for viewing the documentation. Ideal for providing documentation alongside your module or project code. A variation of this module powers the main SilverStripe developer documentation and the user help websites. For more documentation on how to use the module please read /docs/Writing-Documentation.md (or via this in /dev/docs/docsviewer/Writing-Documentation in your webbrowser) Installation ------------ [](#installation) ``` composer require "silverstripe/docsviewer" "dev-master" ``` Usage ----- [](#usage) After installing the files via composer, rebuild the SilverStripe database.. ``` sake dev/build ``` Then start by viewing the documentation at `yoursite.com/dev/docs`. If something isn't working, you can run the dev task at `yoursite.com/dev/tasks/CheckDocsSourcesTask`to automatically check for configuration or source file errors. Out of the box the module will display the documentation files that have been bundled into any of your installed modules. To configure what is shown in the documentation viewer see the detailed [documentation](docs/en/configuration.md). For more information about how to use the module see each of the documentation ``` * [Configuration](docs/en/configuration.md) * [Markdown Syntax](docs/en/markdown.md) * [Syntax Highlighting](docs/en/syntax-highlighting.md) * [Publishing Static Files](docs/en/statichtml.md) ``` License ------- [](#license) See LICENSE ### Health Score 40 — FairBetter than 88% of packages Maintenance15 Infrequent updates — may be unmaintained Popularity32 Limited adoption so far Community34 Small or concentrated contributor base Maturity73 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~81 days Recently: every ~140 days Total 22 Last Release 2468d ago Major Versions 0.2.0 → 1.0.02015-01-07 1.4.0 → 2.0.0-beta12016-06-24 ### Community Maintainers ![](https://www.gravatar.com/avatar/b0cba8b534e20e6ab4fff555a97b237a18436ebca1446fc0b29c8a8b504038b9?d=identicon)[GuySartorelli](/maintainers/GuySartorelli) ![](https://www.gravatar.com/avatar/a25bc04c5720a36869d5a39c6449dde7eb43e19b7c8e666d5f632d6a9ab440b1?d=identicon)[emteknetnz](/maintainers/emteknetnz) ![](https://www.gravatar.com/avatar/afbb3dcc9ef29c1a6eedd6addcae5fce9ab1271915a85a4c349301b71237368d?d=identicon)[silverstripe-machine01](/maintainers/silverstripe-machine01) --- Top Contributors [![wilr](https://avatars.githubusercontent.com/u/101629?v=4)](https://github.com/wilr "wilr (120 commits)")[![chillu](https://avatars.githubusercontent.com/u/111025?v=4)](https://github.com/chillu "chillu (56 commits)")[![dhensby](https://avatars.githubusercontent.com/u/563596?v=4)](https://github.com/dhensby "dhensby (27 commits)")[![Martimiz](https://avatars.githubusercontent.com/u/614243?v=4)](https://github.com/Martimiz "Martimiz (26 commits)")[![robbieaverill](https://avatars.githubusercontent.com/u/5170590?v=4)](https://github.com/robbieaverill "robbieaverill (19 commits)")[![camfindlay](https://avatars.githubusercontent.com/u/367847?v=4)](https://github.com/camfindlay "camfindlay (18 commits)")[![UndefinedOffset](https://avatars.githubusercontent.com/u/1391558?v=4)](https://github.com/UndefinedOffset "UndefinedOffset (10 commits)")[![SpiritLevel](https://avatars.githubusercontent.com/u/8912185?v=4)](https://github.com/SpiritLevel "SpiritLevel (6 commits)")[![ScopeyNZ](https://avatars.githubusercontent.com/u/3260989?v=4)](https://github.com/ScopeyNZ "ScopeyNZ (6 commits)")[![sachajudd](https://avatars.githubusercontent.com/u/24258161?v=4)](https://github.com/sachajudd "sachajudd (5 commits)")[![hdpero](https://avatars.githubusercontent.com/u/13778690?v=4)](https://github.com/hdpero "hdpero (5 commits)")[![mateusz](https://avatars.githubusercontent.com/u/118653?v=4)](https://github.com/mateusz "mateusz (4 commits)")[![sdiel](https://avatars.githubusercontent.com/u/1511086?v=4)](https://github.com/sdiel "sdiel (2 commits)")[![newleeland](https://avatars.githubusercontent.com/u/8085295?v=4)](https://github.com/newleeland "newleeland (1 commits)")[![assertchris](https://avatars.githubusercontent.com/u/200609?v=4)](https://github.com/assertchris "assertchris (1 commits)")[![GuySartorelli](https://avatars.githubusercontent.com/u/36352093?v=4)](https://github.com/GuySartorelli "GuySartorelli (1 commits)")[![jonom](https://avatars.githubusercontent.com/u/1079425?v=4)](https://github.com/jonom "jonom (1 commits)")[![madmatt](https://avatars.githubusercontent.com/u/893117?v=4)](https://github.com/madmatt "madmatt (1 commits)")[![maxime-rainville](https://avatars.githubusercontent.com/u/1168676?v=4)](https://github.com/maxime-rainville "maxime-rainville (1 commits)")[![3Dgoo](https://avatars.githubusercontent.com/u/2616373?v=4)](https://github.com/3Dgoo "3Dgoo (1 commits)") --- Tags documentationsilverstripe ### Embed Badge ![Health badge](/badges/silverstripe-docsviewer/health.svg) ``` [![Health](https://phpackages.com/badges/silverstripe-docsviewer/health.svg)](https://phpackages.com/packages/silverstripe-docsviewer) ``` ### Alternatives [benmanu/silverstripe-styleguide Generates a styleguide for a SilverStripe theme 108.1k1](/packages/benmanu-silverstripe-styleguide)[silverstripe/multi-domain Allows multiple domains to access one CMS instance, mapping them to different sections of the hierarchy 141.6k](/packages/silverstripe-multi-domain) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)