Boson Protocol文档站点
玻色子协议的文档站点挺实用的,适合要上手项目或者想搞清楚整体架构的你。文档结构清晰,启动本地开发也比较方便,用webpack
或jekyll
都行。整体体验还不错,适合那种边看边调试的工作流。
本地开发这块有点意思。想跑起来,用./go content:webpack:serve
或 ./go content:jekyll:serve
,看你喜欢哪套。Webpack 的响应速度还挺快,改完代码刷新一下就能看到效果,适合前端调试。
贡献流程也比较顺,改完代码别忘了先跑下pre-commit
检查格式,用 ./go
就行,能帮你自动跑 lint 规则,省得提 PR 被打回来。
文档里对贡献者也挺友好,小团队维护,但社区氛围不错。如果你发现了啥 bug 或文档不对劲的地方,随时提 issue 或 PR,小型的修改也欢迎,没那么多门槛。
开发服务器方面也推荐你可以看看这些文章,像 Webpack 多协议服务器 和 webpack-plugin-serve,都蛮适合配合这个文档站点一起用,调试起来更顺手。
如果你在搭配 React 或想用 Jekyll 做静态博客,刚好这套文档结构也能当参考模板用。比如 Jekyll 与 Webpack 集成模板 这个项目,也值得一试。
,docs.bosonprotocol.io 是个还挺实用的站点,适合你要深入了解协议细节或者快速搭建本地开发环境时参考。记得边看边跑,效率会更高。
4.38MB
文件大小:
评论区