codex/composer-plugin

Codex 的 Composer 插件。

安装: 169

依赖: 4

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 5

类型:composer-plugin

dev-master / 2.1.x-dev 2019-04-27 07:24 UTC

This package is auto-updated.

Last update: 2024-09-12 00:39:35 UTC


README

Codex 文档

前往 codex-project.ninja 获取完整文档(从本文档开始)以开始使用。

介绍

Codex 是一个基于 Laravel 的基于文件的文档平台。它是完全可定制的,使用起来非常简单,可以创建漂亮的文档。

Codex 能够执行诸如转换 Markdown 或自动从 Bitbucket/Github 仓库获取文档等操作。大多数功能都由插件提供。Codex 是可扩展的、可主题化的、可定制的,并且设置和使用简单。

Codex > 项目 > 修订版 > 文档 > 处理器 > 输出

  • Codex 可以为多个 项目 提供文档。
  • 每个 项目 有一个或多个 修订版(版本)
  • 每个 修订版 包含 文档
  • 每个 文档 都会通过 处理器 进行处理,在显示之前修改其内容。

功能

  • Laravel 5
  • Markdown、Creole 或自定义文档解析器
  • 无限数量地托管 项目/手册 和相应的 版本
  • 可扩展、可主题化、可定制
  • 设置和使用简单
  • 语法高亮显示
  • 在 YAML 中定义的简单导航
  • SEO 优化 URL
  • 基于 Laravel 主题的默认主题
  • 多种存储方法(本地、Dropbox、Amazon 等)
  • 可以作为独立程序或子组件安装到您的(Laravel)项目中。
  • (插件功能)基于标签/分支的 Github/Bitbucket(自动 webhook)同步。
  • (插件功能)流畅的工作,自定义 PHPDoc 集成
  • (插件功能)使用 Github/Bitbucket 登录对项目进行访问限制
  • 还有很多很多!

版权/许可证

版权 2019 Robin Radic - MIT 许可证