创建合辑,将【码上掘金】作为开源项目的demo库使用

avatar
掘金前首席打杂官

最近社区新推出了一个码上掘金的产品,可以方便大家分享在浏览器中可以实时运行的代码了。而这个工具的价值还远不止如此,我们可以利用它构建代码合辑,把它用到自己的开源项目中,为开源项目的用户创建可参考的demo库。

这么做的好处有至少两点,一是不必去费心找可以在项目中构建demo的工具,二是将来码上掘金产品升级,会支持评论、点赞等社交功能,可以极大地方便开源项目作者与用户进行交流。

那么具体要怎么做呢?

首先看一个例子:

www.jcode.pub/?spritejs

上面这个地址是我为我的开源WebGL渲染库SpriteJS写的Demo,这些例子全部都放在了码上掘金上,用户只要访问这里就可以通过例子来了解SpriteJS的用法。

这个合辑功能目前不是码上掘金本身的内置功能,而是决定把它作为开源出来提供给大家共建,这个项目本身集成在JCode-tools这个开源项目中。

如何创建自己的合辑

创建自己的合辑有两个办法,一个简单的办法是将代码发布到码上掘金之后,提交PR给JCode-tools,更新一个配置文件到这里:github.com/xitu/jcode-…

文件名为:你的项目名.jcoderc.js

这样你就可以通过 www.jcode.pub/?你的项目名 来访问你的代码合辑了。

jcoderc文件的写法非常简单,你可以参考 spritejs.jcoderc.js 来配置你自己的代码合辑。

如果你想要把合辑部署到你自己的项目里,那么可以用第二个办法,首先在你的项目里安装 jcode-tools:

npm install jcode-tools

然后在项目目录执行命令 jcode-tools/bin/doc.js 输出目录(缺省为docs)

jcode-tools会在项目的目录下创建一个文档目录,默认为docs,里面有四个文件,分别是:

index.html
index.js
jcoderc.js
style.css

你只需要修改jcoderc.js的配置项即可,然后通过本地运行http-server或者部署到 github pages,就可以创建出你自己的代码合辑了。

以上是码上掘金的一个扩展用法,这个产品的潜力远不止如何,我们也会不断迭代,增加新的语言,增加社交功能,扩展新的用法,更多玩法也有待大家去发掘。

最后放一个有趣的WebGL效果:

code.juejin.cn/pen/7086704…

大家用码上掘金实现了哪些好玩的东西呢?欢迎在评论区交流。