Skip to content
Documentation generator that powers doc.silverstripe.org and your own projects
PHP CSS Scheme JavaScript
Latest commit fd9a7da Jun 24, 2016 @madmatt madmatt committed on GitHub Merge pull request #111 from tractorcow/pulls/make-missingdir-warning
ENHANCEMENT A missing sources dir will simply disable that repo with a warning
Failed to load latest commit information.
_config
code Merge pull request #111 from tractorcow/pulls/make-missingdir-warning Jun 24, 2016
css
docs
images
javascript
lang NEW: Github style code fence blocks. (Fixes #22) Feb 19, 2013
templates
tests BUGFIX: Fixed incorrectly formed page specific anchor links (fixes #104) Mar 11, 2016
thirdparty These changes make a number of improvements, mostly typographical, to… Nov 7, 2014
.editorconfig
.gitattributes
.gitignore
.scrutinizer.yml
.travis.yml Added standard Travis config Nov 21, 2015
README.md ENHANCEMENT A missing sources dir will simply disable that repo with … Jun 21, 2016
_config.php
code-of-conduct.md
composer.json
license.md

README.md

Documentation Viewer Module

Build Status

Maintainer Contact

Requirements

These are pulled in via Composer.

  • SilverStripe 3.1
  • Parsedown and Parsedown Extra.

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

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

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.

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

See LICENSE

Something went wrong with that request. Please try again.