focuslabllc/craft-cheat-sheet

一套快速定制的、即刻可用的字段代码示例。

维护者

详细信息

github.com/focuslabllc/craft-cheat-sheet

主页

源代码

问题

文档

安装数: 20,879

依赖项: 0

建议者: 0

安全性: 0

星标: 210

关注者: 13

分支: 9

开放问题: 13

语言:HTML

类型:craft-plugin

2.0.3 2018-08-13 12:57 UTC

Requires

MIT 464cc1b5a7dc53d9d3ab134c90e80201664ec903

sheetcraftcmscheat

This package is not auto-updated.

Last update: 2024-09-29 05:42:06 UTC

README

如果你像我一样，在项目开发过程中经常需要参考代码示例和语法。当然，像Sublime Text这样的文本编辑器可以添加插件来自动完成和插入代码，但这些插件往往缺乏上下文，你必须在代码准备好和正确之前进行修改。

点击下面的图片了解更多信息，并查看其实际效果。

Watch a video about the Cheat Sheet

Craft Cheat Sheet将代码示例与您正在实际工作的网站上下文相结合。您看到的代码实际上使用的是您的自定义字段名，而不是示例字段名。每个自定义字段都会显示字段类型和一些常见的代码片段，您可以将其复制粘贴到模板中进行快速使用。

Sample Field with code blocks

当您在控制面板中添加新字段时，Craft Cheat Sheet会立即显示新的示例代码。

您可以通过以下链接查看Cheat Sheet的静态示例：http://shared.focus.build/craft-cheat-sheet/

视觉概览

以下是您在Craft字段Cheat Sheet中可以预见的快速概述。

UI with numeric labels

  1. 元素切换
  2. 按组分组菜单
  3. 列表按字母顺序排列
  4. 字段搜索框（适用于拥有大量字段的网站）
  5. 官方标签文档链接
  6. 查看CP链接

安装Craft Cheat Sheet

  • 在网站管理区域找到插件商店中的“Craft Cheat Sheet”
  • 点击“安装”
  • 如果您想自定义前端路由/URL以调用cheatsheet（默认为/cheatsheet），请访问插件设置页面
  • 请参阅此readme中的值得了解的事项部分。
  • 欢欣吧，安装很简单。

自定义代码示例

Cheat Sheet的强大之处在于其极少的设置。Craft通过设计允许字段在多个上下文中使用。您有条目、资产、分类、用户等。所有这些元素都可以在Craft中使用相同的字段。因此，Craft字段Cheat Sheet允许您切换正在使用的元素名称，使您的示例代码更具上下文感知性。无论您正在处理哪个元素，代码示例都将立即准备好。

此外，通常使用Twig的set函数来命名一个元素；或者在for循环中为一个元素使用唯一名称等。这就是为什么您可以添加自己的自定义元素名称。选择您的自定义元素名称会更新您的代码示例，您可以 literally 复制/粘贴/使用而无需进行更改。

Creating and using custom element names

注意：我们正在使用浏览器中的localStorage按主机名保存您的自定义元素，因此您不必经常重新输入它们。

代码中的空白：空格还是制表符！？！？

让我们面对现实。我们都对代码缩进有自己的偏好。我们在构建Craft速查表时也考虑到了这一点。您可以通过自定义代码片段中的空白字符，使得将这些代码片段粘贴到文本编辑器时，无需将制表符转换为空格或反之亦然。

默认设置是使用单个制表符进行缩进。您可以通过访问插件的设置页面来更改此设置。

非原生字段类型

您的网站是否使用了原Craft安装中没有的字段类型？（或者您可能自己创建了一个。）没问题。这些类型也会在自动生成的文档中显示。关键是我们需要意识到这些类型才能包含代码示例。我们将努力确保这些代码示例能够提供。

如果您是插件开发者并希望将您的插件示例代码包含在内，请创建一个pull request以添加您的代码。我们需要遵循特定的格式，所以我们将乐意在过程中帮助您。我们希望Craft速查表能够尽可能包含社区中的所有内容。

值得了解的事情

  • Craft速查表仅在Craft处于开发模式时运行。这是为了保护您可能的数据结构泄露。（毕竟，这是一个开发工具。）
  • 我们曾考虑只在用户登录到控制面板时渲染插件，但最终由于在模板工作中可能出现的会话超时，我们决定不这么做。
  • 这还没有在包含100多个字段的网站上广泛测试。对这些环境中的反馈非常欢迎。
  • 我们有一些额外的功能想法，可以将类似的有用工具引入控制面板。请随时提交您对此的任何想法或意见。说到这个...

一般反馈

我们喜欢反馈！如果您使用这个工具，请告诉我们您的想法，以及它如何帮助您，以及您可能有的任何想法。如果您发现了一个错误，有问题，或者只是需要一些帮助，请将其作为GitHub问题提交。您也可以在Twitter上联系我们@FocusLabLLC。

鸣谢与感谢

我们最初是在构建自己的Craft项目时创建了此工具，这是一个自我服务的工具。但我们认为这个社区可能会从中受益，所以我们决定对其进行美化并免费发布。在那之后，我们收到了一些关键人物的建议、反馈和帮助。