tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 11:05:56 +02:00
Code Issues Projects Releases Wiki Activity
286 Commits 3 Branches 20 Tags 1.4 MiB
PHP 74.9%
CSS 15.8%
Scheme 5.7%
JavaScript 3.6%
720b35d831
Go to file
Cam Findlay 720b35d831 Add a way to check if a version is the current stable 
This allows things like styling or highlighting of the currentl stable version when used in a project to make it more obvious that people should be using that documentation.
2015-10-13 10:30:27 +13:00
_config FIX: Add tests and correct behaviour for next/prev 2014-09-21 11:18:36 +12:00
code Add a way to check if a version is the current stable 2015-10-13 10:30:27 +13:00
css Fixing issue where anchor idicator does not show on hover 2015-06-19 14:53:44 +01:00
docs ENHANCEMENT optional branch property to allow version aliases of development branches inside docsviewer. 2014-12-18 09:41:13 +13: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 Merge branch 'fixsearch' 2014-12-16 23:20:06 +13:00
lang NEW: Github style code fence blocks. (Fixes #22) 2013-02-19 22:23:22 +13:00
templates Bug with Search Entities - removing from form. Removed calls to page entity, there is none when in search controller action 2014-12-16 14:12:40 +13:00
tests API Use canonical URL for all repositories, and instead redirect from non-versioned page to correct canonical URL for each page. 2015-04-28 17:48:12 +12: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 Merge branch 'manifest' 2014-12-16 23:14:19 +13:00
.editorconfig Adding .editorconfig 2014-12-04 15:38:45 +00:00
.gitignore MINOR: ignore ds store files 2012-04-08 21:19:29 +12:00
.travis.yml Move to new travis containerised infrastructure 2015-07-20 15:58:05 +01:00
composer.json API Use canonical URL for all repositories, and instead redirect from non-versioned page to correct canonical URL for each page. 2015-04-28 17:48:12 +12:00
LICENSE Fix RebuildLuceneDocsIndex to use new Markdown parser 2014-11-11 20:44:50 +13:00
README.md Update README.md 2015-01-07 14:09:13 +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.

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