工具介绍
一个基于 Markdown 的文档系统,用于风格指南。
Hologram Hologram 是一个 Ruby 宝石,用于解析 CSS 中的注释,帮助您将它们转换为漂亮的样式指南。构建一个优秀的样式指南有两个步骤: 1. 记录您的 CSS 和 JavaScript,并生成 HTML 示例。 2. 为步骤 1 的输出设计样式。 hologram 宝石本身只关注步骤 1。这意味着您可以自由地让您的样式指南呈现出您想要的样子。如果您不想自己完成这个过程,可以查看我们的 示例仓库,并使用其中定义的资源。
如果您不使用 bundler,可以运行 gem install hologram。
-c 或 --config - 指定配置文件,默认情况下 hologram 会查找 hologram_config.yml
详细信息
要开始使用 hologram,您需要完成以下两项工作:
为项目创建一个 YAML 配置文件。
文档一些代码!
创建 YAML 配置文件
- source: 到源文件的相对路径。可以接受单个值或数组
templates