2017 © Pedro Peláez
 

silverstripe-module docsviewer

Documentation viewer module for SilverStripe

image

silverstripe/docsviewer

Documentation viewer module for SilverStripe

  • Friday, June 8, 2018
  • by chillu
  • Repository
  • 13 Watchers
  • 18 Stars
  • 11,935 Installations
  • PHP
  • 5 Dependents
  • 0 Suggesters
  • 26 Forks
  • 8 Open issues
  • 23 Versions
  • 5 % Grown

The README.md

Documentation Viewer Module

ABANDONED

This package is abandoned. See silverstripe/doc.silverstripe.org instead., (*1)

Build Status, (*2)

Maintainer Contact

Requirements

These are pulled in via Composer., (*3)

  • 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., (*4)

A variation of this module powers the main SilverStripe developer documentation and the user help websites., (*5)

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), (*6)

Installation

composer require "silverstripe/docsviewer" "dev-master"

Usage

After installing the files via composer, rebuild the SilverStripe database.., (*7)

sake dev/build

Then start by viewing the documentation at yoursite.com/dev/docs., (*8)

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., (*9)

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., (*10)

For more information about how to use the module see each of the documentation, (*11)

* [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, (*12)

The Versions

08/06 2018

dev-master

9999999-dev

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

08/06 2018

2.0.0-rc3

2.0.0.0-RC3

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

29/01 2018

2.0.0-rc2

2.0.0.0-RC2

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

13/11 2017

2.0.0-rc1

2.0.0.0-RC1

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

30/08 2017

2.0.0-beta8

2.0.0.0-beta8

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

14/08 2017

2.0.0-beta7

2.0.0.0-beta7

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

29/06 2017

2.0.0-beta6

2.0.0.0-beta6

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

12/12 2016

2.0.0-beta5

2.0.0.0-beta5

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

04/12 2016

2.0.0-beta4

2.0.0.0-beta4

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

20/10 2016

2.0.0-beta3

2.0.0.0-beta3

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

12/08 2016

2.0.0-beta2

2.0.0.0-beta2

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

24/06 2016

2.0.0-beta1

2.0.0.0-beta1

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

29/02 2016

1.4.0

1.4.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

06/02 2016

1.3.0

1.3.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

30/11 2015

1.2.0

1.2.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

21/11 2015

1.1.0

1.1.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

26/07 2015

dev-docsviewer-works-with-ss4

dev-docsviewer-works-with-ss4

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

20/07 2015

1.0.2

1.0.2.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

01/05 2015

1.0.1

1.0.1.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

07/01 2015

1.0.0

1.0.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

05/12 2014

0.2.x-dev

0.2.9999999.9999999-dev

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

05/12 2014

0.2.0

0.2.0.0

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe

11/01 2014

0.1.x-dev

0.1.9999999.9999999-dev

Documentation viewer module for SilverStripe

  Sources   Download

BSD-3-Clause

The Requires

 

documentation silverstripe