codex/core

Codex的核心包。这是启动Codex所需的最小要求。

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

This package is auto-updated.

Last update: 2024-09-09 05:19:57 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 许可证