linkorb/stylex

用于管理风格指南、政策和规则手册的工具包

维护者

详细信息

github.com/linkorb/stylex

主页

源代码

问题

安装: 1

依赖项: 0

建议者: 0

安全: 0

星级: 1

关注者: 4

分支: 0

开放性问题: 0

v1.0.0 2018-10-28 14:54 UTC

Requires

MIT 7aaa407a345b929bea3c6483389b4c31738024ee

  • LinkORB Engineering <engineering.woop@linkorb.com>

Contextlinkorb

This package is auto-updated.

Last update: 2024-08-29 04:09:20 UTC

README

X（所有内容）的风格指南工具包

用例

  • 语言风格指南（例如php、javascript、markdown等）
  • 特定组织的编码约定
  • 文件格式风格指南（例如YAML文件中的空白使用等）
  • 技术写作风格指南
  • 语气风格指南
  • 品牌风格指南（标志、品牌颜色、字体等的使用）

用法

通过composer全局安装stylex

composer global require linkorb/stylex

现在cd进入-style-guide目录并运行

stylex template path-to-my-templates build/

template命令将从当前目录加载风格指南文件（yaml、json、md等），并通过您的模板目录中的（handlebars）模板运行。生成的输出文件将保存在build/

示例

查看example/目录。

要构建此风格指南，只需运行

cd example/
../bin/stylex template ../templates/basic/ build/
open build/index.md

出色的风格指南

想要为这个部分建议其他出色的风格指南吗？只需发送一个PR！

许可证

MIT（查看LICENSE.md）

由LinkORB工程技术团队提供


查看我们在linkorb.com/engineering上的其他项目。

顺便说一下，我们正在招聘！