Skip to content

A Neos backend module for reading the documentation of the installed packages

License

Notifications You must be signed in to change notification settings

calcalid/DocViewer

This branch is 19 commits behind techdivision/DocViewer:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

201ff80 · Apr 24, 2017

History

16 Commits
Apr 24, 2017
Apr 23, 2017
Apr 18, 2017
Apr 23, 2017
Apr 11, 2017
Apr 7, 2017
Apr 12, 2017
Apr 23, 2017
Apr 23, 2017
Apr 19, 2017
Apr 23, 2017

Repository files navigation

TechDivision.DocViewer

This Neos package provides a backend module which renders Markdown in the "Documentation" folder of all installed packages. The idea is Neos.Editors are able to read a project specific manual about the project.

For examle in your Neos site are some complex editing or configuration features for the Neos.Editors. With this module are you able to provide them a manuel for your project.

Why not reStructuredText?

At this point there is no stable php solution rendering RST especially the Neos docs. To avoid complex dependencies this project supports only Markdown yet.

Features

  • List installed packages with documentation
  • Rendering markdown with common features
  • Configurable blacklist to hide packages
  • Configurable default packages

TechDivision Logo

TBD

  • configurable optional sub-directory inside the Documentation directory for rendering to enable the possibility for a developer documentation and an user manual

About

A Neos backend module for reading the documentation of the installed packages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 69.0%
  • HTML 14.8%
  • CSS 9.1%
  • JavaScript 7.1%