README

EasyDocs 允许您使用内置仪表板创建和编辑用户文档，仪表板围绕用户定义的各种主题组织文档。

运行 EasyDocs 不需要数据库。完整安装过程不到五分钟，您将能快速启动文档！

功能

EasyDocs 中有许多功能，使创建用户文档变得简单

• 数据库（较少）：EasyDocs 的主要特点之一是不需要任何类型的数据库。
• 易于配置：EasyDocs 的大部分内容都可以通过一个配置文件进行修改。该文件使用非常易于理解的术语定义，这意味着即使没有编程知识的人也能知道他们正在修改什么。
• ADA 兼容性：为用户生成的文档默认为完全 ADA 兼容。
• MVC-like 架构：EasyDocs 源代码的结构意味着修改很简单。无需在混乱的代码库中查找以编辑特定模板的视觉元素。

先决条件

• 安装了 PHP 7.1.3+ 的 Web 服务器
• 文件读取/写入权限（EasyDocs 包含的 docs/ 文件夹所需的）
• Composer

安装

使用 Composer

1. 运行以下命令以下载 composer 包

composer create-project chx2/easydocs

1. 编辑 app/ 目录下的 config.yaml 文件以更新您的用户名和密码，并添加任何其他用户。已提供一个默认值，但建议您更改它。您可以在名为 users 的 YAML 块中编辑当前用户并添加新用户

admin: '1234'

首次登录后，您可以创建和添加新用户以及更改密码。

1. 输入 Web 服务器 URL 以登录。在 ACP（通过将 /login 添加到 URL 可以访问）中创建您的第一个部分后，您就可以开始编写文档了！

修改

如果您愿意，可以修改 EasyDocs 的布局和/或功能。

在仪表板设置中，您可以上传自己的自定义主题！应用程序中已捆绑一个默认主题。有关创建自定义主题的文档即将推出！目前，您可以自定义

1. 样式和脚本
2. 模板
3. 路由文件（可选）

手册文档

虽然 EasyDocs 的预期用途是提供一个编辑器来帮助您创建文档，但如果您选择这样做，也可以手动创建文档。请注意，您应该遵循以下步骤以确保您的添加不会在应用程序中引起任何问题

1. 在您的config.yaml文件中，将您的新页面名称添加到Pages变量下已存在的某个部分。如果您想创建新部分，也需要添加该部分。

Pages: Default: [Test]

1. 在docs/文件夹下，将您的页面名称添加到您指定的部分文件夹中。如果您正在创建新部分，需要创建新文件夹。

docs/Default/Test.md

1. 编辑您的新文档文件，完成后保存。下次访问应用程序时，您的文档将显示出来。

致谢

EasyDocs中使用了多个插件，以简化使用。

后端

• Bramus Router
• Smarty 模板引擎
• Symfony Yaml 解析器
• 标记解析器

前端

• Bulma 框架
• hunzaboy CSS 复选框
• jQuery
• jQuery UI
• Inscryb Markdown 编辑器（基于Sparksuite的原始版本进行分支开发）
• Font Awesome 图标

错误报告

如果您发现EasyDocs默认设置下有问题，请随时提交问题。

注意，如果错误是在EasyDocs的自定义修改后发生的，我将不会回应报告。唯一的例外是，如果EasyDocs内部有某些功能没有按预期行为，因此导致错误。

请将任何报告提交到https://github.com/chx2/EasyDocs/issues

贡献

请访问这里 https://github.com/chx2/EasyDocs/pulls