techdivision/docviewer

Last activity on 2 February 2021
  • 1
  • 2
  • 7829
composer require techdivision/docviewer

This neos package enables you to read the docs of the installed packages

5.03

This neos package enables you to read the docs of the installed packages

Version
5.03
Type
neos-package
Release Date
23.02.2021 20:32:57
Source
git
Distribution
zip
Requires
Requires (dev)
None
Suggest
None
Provides
None
Conflicts
None
Replaces
None
GPL-3.0+
  • #documentation
  • #module
  • #backend
  • #neos
80c3d8824ca71017b11014bc3110c1da40df6b07

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
The content of the readme is provided by Github
The same vendor provides 15 package(s).