tonyair
/
silverstripe-docsviewer
mirror of https://github.com/silverstripe/silverstripe-docsviewer
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
352 Commits 3 Branches 20 Tags 1.4 MiB
PHP 74.9%
CSS 15.8%
Scheme 5.7%
JavaScript 3.6%
Go to file
Cam Findlay e38b740d88 Create sidebar hamburger menu for mobile (#121) 
* Create sidebar hamburger menu for mobile

* Improve sidebar UX and mobile menu

* Fixed sidebar UX bug where blue text breadcrumb didn't appear and fixed hover/focus styling

* Improved UX of hamburger by applying toggle animations
 		2016-10-21 10:49:50 +13:00
_config FIX: Add tests and correct behaviour for next/prev 2014-09-21 11:18:36 +12:00
code Updated invalid url for syntax highligter 2016-07-21 19:42:32 +12:00
css Create sidebar hamburger menu for mobile (#121) 2016-10-21 10:49:50 +13:00
docs ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 18:00:30 +12:00
images These changes make a number of improvements, mostly typographical, to improve readability and to render properly on small devices. 2014-11-07 12:01:07 +13:00
javascript Create sidebar hamburger menu for mobile (#121) 2016-10-21 10:49:50 +13:00
lang Created Croatian language files (#114) 2016-08-12 12:33:38 +01:00
templates Create sidebar hamburger menu for mobile (#121) 2016-10-21 10:49:50 +13:00
tests BUGFIX: Fixed incorrectly formed page specific anchor links (fixes #104) 2016-03-11 13:15:37 -04:00
thirdparty These changes make a number of improvements, mostly typographical, to improve readability and to render properly on small devices. 2014-11-07 12:01:07 +13:00
.editorconfig Added standard editor config 2015-11-21 19:51:34 +13:00
.gitattributes Added standard git attributes 2015-11-21 20:09:58 +13:00
.gitignore MINOR: ignore ds store files 2012-04-08 21:19:29 +12:00
.scrutinizer.yml Added standard Scrutinizer config 2015-11-21 19:34:48 +13:00
.travis.yml Added standard Travis config 2015-11-21 19:43:06 +13:00
README.md ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 18:00:30 +12:00
_config.php Merge branch 'manifest' 2014-12-16 23:14:19 +13:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:19:12 +13:00
composer.json ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 18:00:30 +12:00
license.md Updated license year 2016-01-01 06:31:01 +13:00

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