马奇
为制图师所制作的像素相通点兴趣图标集.
此 repo 只包含源 SVG 文件 。 检查出来 马基网站 用于使用图标编辑工具并读取详细的设计指南.
格式
- 源图标为SVG文件格式.
- 图标有两种大小:11px x 11px和15px x 15px.
- 图标只应由路径和组组成。 路径只应该有一个
d属性. - 每个图标的 svg 标签应该有一个
id不包含扩展名的属性。 这个id属性作为承诺前钩子的一部分自动添加.
对于开发者
Maki已准备好供开发者使用. 通过国家预防机制安装 Maki :
npm install @mapbox/maki --save
Maki 模块导出 layouts 用于在应用程序或网站上组织和显示图标。 以下是节点中的用法示例:
var maki = require('@mapbox/maki');
files.forEach(function(fileName, j) {
maki.layouts.all.forEach(function(icon) {
fs.readFile(maki.dirname + '/icons/' + icon + '-11.svg', 'utf8', function(err, file) {
// Read icons as strings in node
console.log(file);
});
});
});
关于分支的说明
马基项目的主要分支是 master。 。 。 .
马基的旧版本仍然存在于 mb-pages 分支,它必须保持不变,因为一些旧的 Mapbox 项目依赖于它服务的文件 www/ 目录.
图标请求
Maki欢迎需要关注点图标的人提出的图标请求. 打开一个问题来提出请求,并确保提供问题模板中概述的必要信息.
提供新 Maki 图标的工作流程
Maki也欢迎设计师的贡献,他们需要图标来表达具体的兴趣点. 看看这个 设计准则 在打开一个问题之前.
请遵照这些步骤向马寅初献出.
1: 创建问题
打开一个问题并确保提供问题模板中概述的必要信息。 如果您的请求是一组图标, 请为每个图标创建单个请求问题 。 这张票是所有与您的图标设计相关的通讯和文档都将出现和存放的地方.
2: 创建分支
从主分支创建新分支。 以图标命名分支; 例如, 如果您正在创建一个新的“ 花园” 图标, 您的分支名称将是“ 花园 ” 。 如果图标请求是一组图标,则为图标组创建一个分支,并命名为简洁和描述性的东西.
3:图标设计
你现在可以设计你的图标了。 一个良好的起点是使用我们的 Illustrator 或 Inkscape 模板,它们有 11 和 15 像素尺寸集和.svg 导出注释 . 在您设计图标时,将草稿张贴到票上以获取反馈. 建议在每个大稿后贴出,使到最后,整个设计过程都有记录. 这些文件将有助于未来的设计师为马基做出贡献.
如果你正在为另一个人设计一个图标,那么你和请求者之间的所有通信也应当在票上进行.
在创建拉动请求前完成图标设计. 重複:从头尝试并记录到完成票面上的设计过程.
4: 文件检查测试( T)
检查您的文件是否为不相干锚点, 确保文件为单一路径, 并双倍检查文本编辑器中的. svg 文件 。 在 Maki 编辑器中打开 . svg 文件以确保其兼容, 或运行 npm test 以确保测试通过。 如果图标不能被编辑器打开或测试失败,则很可能是几何或不必要的代码如您.svg文件中的css的问题.
Maki的每个图标都必须通过自动测试 测试/maki.test.js。这些测试检查如下:
- 文件名必须用"-11. svg"或"-15. svg"结尾 .
- SVG文件不能包含以下元素:矩形,圆形,椭圆形,线形,多线形,多边形.
- SVG 文件不能包含已转换的组或路径 .
- 高度和宽度必须等同为11或15,而高度和宽度必须等同.
- 高度,宽度,和取景箱必须使用像素单位.
5: 创建拉动请求最后审查( L)
创建拉出请求,如有需要,由马基团队成员通过技术反馈支持您. 请在拉票申请中加入相关票的链接 .
6: 合并到主分支
最终审查批准后,马基一队成员会将图标分会与主分会合并,并关闭你的请求票.
释放程序
1: 更改日志并发布 Maki 寄存器
将 ChangeGELOG.md 文件中发生的所有更新记录在 dev 分支所使用的版本编号下.
更新 Maki 寄存器包.json 文件的版本编号并运行 npm publish。 。 。 .
2:更新Maki网站
在maki-icons寄存器中,更新包.json文件中的Maki依赖版本编号.
许可证
