techdivision/docviewer

Composer 安装命令：


                            composer require techdivision/docviewer

包简介

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

关键字：

#documentation #module #backend #Neos

README 文档

README

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

TBD

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

techdivision/docviewer 适用场景与选型建议

techdivision/docviewer 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 11.15k 次下载、GitHub Stars 达 2，最近一次更新时间为 2017 年 04 月 19 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「module」「backend」「Neos」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 techdivision/docviewer 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 techdivision/docviewer 我们能提供哪些服务？

定制开发 / 二次开发

基于 techdivision/docviewer 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发