Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Documentation generator that powers and your own projects
PHP CSS Scheme JavaScript
branch: master
Failed to load latest commit information.
code Use symlink path name (Fixes #58)
css FIX: margin around edit too small and causes UI problems with nav.
docs ENHANCEMENT optional branch property to allow version aliases of deve…
images These changes make a number of improvements, mostly typographical, to…
javascript Merge branch 'fixsearch'
lang NEW: Github style code fence blocks. (Fixes #22)
templates Bug with Search Entities - removing from form. Removed calls to page …
tests TEST updated as clean name now respects the writing style conventions.
thirdparty These changes make a number of improvements, mostly typographical, to…
.editorconfig Adding .editorconfig
.gitignore MINOR: ignore ds store files
.travis.yml Travis support
LICENSE Fix RebuildLuceneDocsIndex to use new Markdown parser Update
_config.php Merge branch 'manifest'
composer.json Merge branch 'manifest'

Documentation Viewer Module

Build Status

Maintainer Contact


These are pulled in via Composer.

  • SilverStripe 3.1
  • Parsedown and Parsedown Extra.


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/ (or via this in /dev/docs/docsviewer/Writing-Documentation in your webbrowser)


composer require "silverstripe/docsviewer" "dev-master"


After installing the files via composer, rebuild the SilverStripe database..

sake dev/build

Then start by viewing the documentation at

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.

For more information about how to use the module see each of the documentation

* [Configuration](docs/en/
* [Markdown Syntax](docs/en/
* [Syntax Highlighting](docs/en/
* [Publishing Static Files](docs/en/



Something went wrong with that request. Please try again.