Documentation generator that powers doc.silverstripe.org and your own projects
PHP CSS Scheme JavaScript
Latest commit ded5432 Dec 12, 2016 @tractorcow tractorcow committed on GitHub Merge pull request #128 from robbieaverill/bugfix/127-use-stable-vers…
…ion-in-all-page

Use the current version to filter pages in the "documentation index"
Permalink
Failed to load latest commit information.
_config
code
css
docs
images
javascript PSR2 Formatting Dec 2, 2016
lang Hotfix/remove search hamburger (#125) Nov 4, 2016
templates
tests
thirdparty PSR2 Formatting Dec 2, 2016
.editorconfig
.gitattributes Added standard git attributes Nov 21, 2015
.gitignore
.scrutinizer.yml Added standard Scrutinizer config Nov 21, 2015
.travis.yml Remove old CORE_RELEASE versions Dec 2, 2016
README.md ENHANCEMENT A missing sources dir will simply disable that repo with … Jun 21, 2016
_config.php PSR2 Formatting Dec 2, 2016
code-of-conduct.md Added standard code of conduct Nov 21, 2015
composer.json ENHANCEMENT A missing sources dir will simply disable that repo with … Jun 21, 2016
license.md Updated license year Dec 31, 2015

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