mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 09:05:56 +00:00

Go to file

Uncle Cheese c71a1aaca2 These changes make a number of improvements, mostly typographical, to improve readability and to render properly on small devices.

Universal increase in font size
Use same font as ss.org for consistency
Remove unnecessary visual noise (borders, box shadows, etc)
Use Google PrettyPrint syntax highlighter for improved readability of code sections
Fully responsive, with hamburger menu
Add "section" linking mode to menu items
Add masthead for breadcrumbs, introduction
Improved styles for notice/info/warning messaging

2014-11-07 12:01:07 +13:00

_config

FIX: Add tests and correct behaviour for next/prev

2014-09-21 11:18:36 +12:00

code

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

css

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

docs

Kill DocumentationService in favour of config API.

2014-09-07 17:09:28 +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

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

lang

NEW: Github style code fence blocks. (Fixes #22 )

2013-02-19 22:23:22 +13:00

templates

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

tests

Restore tests

2014-09-28 21:41:10 +13: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

_config.php

Overhaul of module to use DocumentationManifest

2014-09-07 11:26:12 +12:00

.gitignore

MINOR: ignore ds store files

2012-04-08 21:19:29 +12:00

.travis.yml

Travis support

2013-03-29 09:38:02 +01:00

composer.json

Upgrade parsedown extra to support markdown within code blocks

2014-09-28 13:26:54 +13:00

LICENSE

ENHANCEMENT: rolled out basic versioning support.

2011-07-01 13:19:35 +12:00

README.md

Overhaul of module to use DocumentationManifest

2014-09-07 11:26:12 +12:00

README.md

Documentation Viewer Module

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.

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