mirror of
https://github.com/silverstripe/silverstripe-docsviewer
synced 2024-10-22 11:05:56 +02:00
43b6d42719
This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction().
51 lines
1.6 KiB
Markdown
Executable File
51 lines
1.6 KiB
Markdown
Executable File
# Documentation Viewer Module
|
|
|
|
[](http://travis-ci.org/silverstripe/silverstripe-docsviewer)
|
|
|
|
## Maintainer Contact
|
|
|
|
* Will Rossiter (Nickname: willr, wrossiter)
|
|
<will@fullscreen.io>
|
|
|
|
## Requirements
|
|
|
|
* SilverStripe 3.1
|
|
|
|
## 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`.
|
|
|
|
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
|
|
|
|
See LICENSE |