发布你的组件到webcomponents.org

beta.webcomponents.org是一个可以:

  • 发布自己的自定义组件或组件集合
  • 查看别人发布的自定义组件或组件集合
  • 查看组件的readme、demo及API文档

的网站。事实上Polymer的Element Catalog已经会重定向到这里。
本文会介绍一下怎么在上面发布自己的组件。

Publish your element已经很详细地讲解了如何发布及相关细节,本文只是对其的翻译、整理。

组件要求

你的组件必须符合下面要求:

  • 使用开源许可。没特殊要求的话可以直接使用非常自由的MIT;把写好的许可文件保存在项目根目录下的LICENSE就可以了。
  • Tag & Release。你需要对你的项目打tag,最好是使用语意化版本。
  • Readme。你可以直接使用模板;另外webcomponents.org支持直接在Readme中显示demo,这个我们会在下文提到。

Release(打tag)步骤:

  • checkout到合适的分支或commit,然后运行git tag [version],例如git tag v0.1.0
  • git push origin v0.1.0

发布!

完成上述的准备后:

  • 进入Publish your element
  • 找到中间的"Ready to publish?"
  • 输入github项目的地址,[username]/[project_name]
  • 勾选"I'm not a robot"
  • 点击Publish

Better Readme

下面是一些可选的功能。

添加徽章

你可以添加这个一个徽章:


到你的项目readme里,声明这已经是一个webcomponents.org发布的组件。
直接复制下面代码到你的项目readme.md里。

[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://beta.webcomponents.org/element/owner/my-element)

在Readme里显示demo

Webcomponents.org可以在展现项目Readme的时候直接根据里面的代码来显示demo:

<!--
```
<custom-element-demo>
  <template>
    <link rel="import" href="my-element.html">
    <next-code-block></next-code-block>
  </template>
</custom-element-demo>
```
-->
```
<my-element></my-element>
```

HTML注释内的内容就是最后会显示的demo内容;next-code-block会将注释下一段的例子代码(my-element那段)生成在demo内。
HTML注释内的内容可以自由编辑,例如你想有一个特定高度的div来撑开body:

    <div style="height: 200px">
      <next-code-block></next-code-block>
    </div
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,601评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,522评论 25 707
  • 下面这件事件这是我高三那年发生的… 那天,寒风吹到脸上都生疼生疼的。我下了艺考班统一去校考的大巴车上。羽绒服根本挡...
    Moniii阅读 249评论 1 1
  • 收到读书分享会秘书发来的通知,晚上又是我们每周一次的读书分享会时间了,打开读书笔记把新的读后感补充上去。自从加入系...
    心梦飞翔h阅读 255评论 0 1