README

这是一个有用的框架，可以更容易地创建符合模块标准的 Silverstripe CMS 模块。

本 README 包含了关于您应该自定义此模块基的各个部分的描述，以满足您的模块需求。例如，上面 H1 中的模块名称应该是您自己的模块名称，而您现在正在阅读的描述文本是您提供关于您的模块做什么的良好简短说明的地方。

尽可能的情况下，我们已经包括了可以作为是直接包含到您的模块中的默认文本，并在其他地方指明了您需要自定义它的地方。

以下是您 README.md 中应包含的理想部分的模板，以符合模块标准并帮助他人使用您的模块。

准备此模块用于您自己的使用步骤

确保您阅读了 '发布模块' 指南，并更新您的模块的 composer.json 以将您的代码指定为 Silverstripe CMS 模块。

将此存储库克隆到一个文件夹中
将您的姓名/组织添加到 LICENSE.md
更新此 README 以包含有关您模块的信息。确保删除不相关的部分，并在相关部分编辑占位符。
检查提供的各个目录中的 README 文件。当您添加了您的代码后，您应该最终删除这些 README 文件。
使用您的需求更新模块的 composer.json
使用您的需求更新（或删除）package.json。运行 yarn install（或删除 yarn.lock）以确保正确解决依赖关系。
通过运行 rm -rf .git && git init 清除 git 历史
添加并推送到 VCS 仓库
在 packagist.org 上发布模块，或将自定义仓库添加到您的主要 composer.json 中。
在您的 main composer.json 中要求模块
如果您需要构建您的 css 或 js，并且使用来自 silverstripe/admin 的组件、注入器、scss 变量等
- 确保通过 composer install --prefer-source 而不是默认的 --prefer-dist 安装 silverstripe/admin（如果您已经安装了它，可以使用 composer reinstall silverstripe/admin --prefer-source）
- 如果您依赖 silverstripe/admin 的附加依赖项，而不是将它们作为依赖项添加到您的 package.json 文件中，您需要通过在 vendor/silverstripe/admin/ 目录中运行 yarn install 来在 silverstripe/admin 中安装第三方依赖项。
开始开发您的模块！

此模块模板默认使用 "BSD-3-Clause" 许可证。BSD-3 许可证是最宽松的开源许可证之一，并被大多数 Silverstripe CMS 模块使用。

要将您的模块发布在不同的许可证下

您可以使用choosealicense.com来帮助您为您的项目选择合适的许可证。

您不需要在README文件中保留此部分 - LICENSE.md文件就足够了。

在以下命令中将silverstripe-module/skeleton替换为您模块的composer名称。

composer require silverstripe-module/skeleton

注意： 当您完成您的模块后，将其提交到Packagist或将其作为VCS存储库添加到项目的composer.json中，指向私有存储库URL。

在此处将链接添加到您的docs/<language>文件夹中，除非您的模块只需要最少的文档，在这种情况下，请在此处添加并删除docs文件夹。如果您有多个文档页面，这可以作为一个快速的内容表。

如果您的模块使用了Silverstripe CMS的config API，提供示例配置是一个好主意，这样可以让模块直接运行并使用户了解可能的配置选项。尽管请注意，在许多情况下，仅仅链接到文档就足够了。

尽可能提供语法高亮的代码示例。

Page:
  config_option: true
  another_config:
    - item1
    - item2