README

Phalcon 用户指南模块

基于 Kohana 的用户指南的 Phalcana 项目模块。

安装

此模块默认通过 composer 随 Phalcana 项目安装，如果包含开发模块，请参阅 Phalcana 项目了解更多信息。

为了将模块加载到 Phalcana 中，需要在模块配置中添加该模块。这可以在 app/config/static.php 或本地版本 app/config/setup.php 中找到。例如。

'modules' => array(
  'email' => MODPATH.'email/',
  'userguide' => MODPATH.'userguide/',
),

基本用法

模块成功安装后，您可以通过访问 URL /guide 来访问它。

添加到指南中

指南的文件位于每个模块和系统文件夹中的 guide/module-name 内。添加的文件使用 Markdown 语法。有关 Markdown 的更多信息，请参阅下面的内容。

每个模块的主页应该命名为 index.md，而将文件连接在一起的菜单结构应添加到 menu.md 文件中。

API 浏览器

用户指南还包含一个 API 浏览器，该浏览器由代码中的 DOC 块组装而成。这与 PHPDocumentor 类似，通过使用主要类的 DOC 块排序，首先是 @package，然后是 @category。代码块使用 Markdown 格式化类的文档以及每个单独的函数的文档。有关 Markdown 语法的更多信息，请参阅下面的内容。

Markdown

大多数 Markdown 解析由 PHP Markdown 处理。有关详细信息，请访问文档。有一些修改允许重写本地链接。

phalcana / userguide

维护者

详细信息