mirror of
https://github.com/silverstripe/silverstripe-docsviewer
synced 2024-10-22 11:05:56 +02:00
f1bd774437
* manifest: (50 commits) TEST updated as clean name now respects the writing style conventions. FIX Showing the stable and outdated version number correctly. FIX: margin around edit too small and causes UI problems with nav. Upper case first letter Fixing text highlight css Reduce exception. Refactored EditLink Restore support for multiple versions in the masthead These changes make a number of improvements, mostly typographical, to improve readability and to render properly on small devices. Add support for exclude in children list Fix style of submenu Restore tests FIX: permission check broken Add alert as a valid alias as warning. Support one more layer in the template. Encode &s; in api links. Minor style tweaks Upgrade parsedown extra to support markdown within code blocks FIX: API links should be urlencoded() to prevent special characters causing issues Correct title generation for index files in entity root ... Conflicts: code/tasks/RebuildLuceneDocsIndex.php
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# 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 |