代码段就是可以插入到编辑器中的一段文本,可以节省键入时间,减少语法错误。
atom-snippets.cson 文件中所提供的代码段只用于在 Atom 中的 Markdown 文件。
将 atom-snippets.cson 文件中的内容复制到现有的~/.atom/snippets.cson 之中。
不要替换现有的文件。
不需要重启 Atom。
浏览一遍 atom-snippets.cson 文件,记下代码段的标题和 prefix。
你可以使用以下任意一种方式来触发相应的代码段:
- 键入代码段的prefix,按下 <TAB> 键
- 在 Packages / Snippets / Available 中搜索代码段的标题
例如,打开一个 Markdown 文件,键入 anote,按下 <TAB>。
就会插入一段带有正确的 Hugo 短代码的空注释。
代码段可以插入一行或多行文本。一些代码行都设有预留值。想要切换到下一个预留值,再按一次<TAB> 键即可。
一些代码段只会插入部分格式的 Markdown 或 Hugo 语法。
例如,coverview 只会插入一个概念概览的开始标签,而cclose则会插入一个结束标签。
这是因为每类 capture 都需要一个 capture-close 标签。
从空白文件中,创建一个新的概念,任务或者教程,使用以下的代码段:
newconceptnewtasknewtutorial预设文本包含其中。
atom-snippets.cson 文件中。
提交 pull request,邀请 Kubernetes Slack #sig-docs 中的另外一名 Atom 用户进行审查。