此项目致力于帮助大家更好的理解和快速上手 Jetpack Compose 框架, 更多的部分是为了补充官网可能没有介绍的东西
有问题欢迎提交 issue 来提问
欢迎来学习!
如果你想为 Jetpack Compose 做贡献的话,你可以加入 Kotlin 的 Slack 频道 #Compose, 或者在 https://issuetracker.google.com/issues?q=componentid:612128 中提交 Compose 的 Bug 或者错误
我们非常欢迎各种的 PR 请求(包括但不局限于添加一个换行增加阅读体验),_(:з)∠)_本项目还处于初期阶段,非常需要各位大佬的完善和纠错
如果你有已经写好的文章想要添加到这里,欢迎发送 Markdown 格式的文件给我们!
文档采用 docusaurus 来编辑及部署
npm install
在项目根目录终端执行 npm run start
,将会在 http://localhost:3000/
看到文档
文档都是由 Markdown 语法来编写的,所有文档位于 /docs 中, 如果需要扩展左边的侧边栏,请在 sidebars.js 更新。
图片添加需要在 static/img/ 下,和文档同等路径名字添加。例如如果我修改了 Text 的文档,并且添加了一张例图,那么就是放在 /static/img/elements/text/xxx.png。
运行 npm run-script build
会生成 build
文件夹,期间 docusaurus
会打印日志告诉你是否有 WARNING 或者 ERROR(一般可能是路径错误等)
恭喜你,当你同步了本项目的最新进度并且添加了你所想的东西,你只需要提交 PR 即可,我们在审核通过会自动同步到网站上
本作品采用知识共享署名-非商业性使用 2.0 通用许可协议进行许可。
除特别注明外,项目中除了代码部分均采用非商业性使用 2.0 通用 (CC BY-NC 2.0) 进行许可。
您可以自由地:
共享 — 在任何媒介以任何形式复制、发行本作品
演绎 — 修改、转换或以本作品为基础进行创作
但是你必须遵守:
署名 — 您必须给出适当的署名,提供指向本许可协议的链接,同时标明是否(对原始作品)作了修改。您可以用任何合理的方式来署名,但是不得以任何方式暗示许可人为您或您的使用背书。
非商业性使用 — 您不得将本作品用于商业目的。