Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Latest commit

 

History

History
116 lines (74 loc) · 5.71 KB

README.md

File metadata and controls

116 lines (74 loc) · 5.71 KB

GitHub stars

Important

此仓库暂时归档,因为我近期已经没有时间继续去维护和更新这份文档了,一方面是自己的知识储备还不足以继续写内容上去,另一方面是谷歌官网的文档已经慢慢更新地很完善了,希望大家都去看官网的内容吧

介绍 💨

国内第三方镜像 (加载速度快,内容可能略滞后于官网)https://compose.funnysaltyfish.fun

此项目致力于帮助大家更好的认识 Jetpack Compose 框架, 更多的部分是为了补充官网可能没有介绍的东西。

有问题欢迎提交 issue

一起进步!

关于贡献

Jetpack Compose

如果你想为 Jetpack Compose 做贡献的话,你可以加入 Kotlin 的 Slack 频道 #Compose, 或者在 https://issuetracker.google.com/issues?q=componentid:612128 中提交 Compose 的 Bug 或者错误

本项目

我们非常欢迎各种的 PR 请求(包括但不局限于添加一个换行增加阅读体验),_(:з)∠)_本项目还处于初期阶段,非常需要各位大佬的完善和纠错。

如果你有已经写好的文章想要添加到这里,欢迎提交 PR。

文档采用 docusaurus 来编辑及部署

本地部署文档 & 编辑文档

git clone https://github.com/compose-museum/jetpack-compose-book.git
npm install

在项目根目录终端执行 npm run start,将会在 http://localhost:3000/ 看到文档

如何添加/更改文档?

文档都是由 Markdown 语法来编写的,所有文档位于 /docs 中, 如果需要扩展左边的侧边栏,请在 sidebars.js 更新。

图片添加需要在 static/img/ 下,和文档同等路径名字添加。例如我修改了 Text 的文档,并且添加了一张例图,那么就是放在 /static/img/elements/text/xxx.png

调用图片方法

如何测试

运行 npm run build 会生成 build 文件夹,期间 docusaurus 会打印日志告诉你是否有 WARNING 或者 ERROR(一般可能是路径错误等)

基于 Docker 部署

Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何环境中

  1. 安装 DockerDocker Compose

  2. 新建目录用于存放 docker-compose.yml 文件和项目文件

  3. 在目录下新建 docker-compose.yml 文件,内容如下:

version: "3.7"

services:
  docusaurus:
    container_name: docusaurus
    image: awesometic/docusaurus
    volumes:
      - ./jetpack-compose-book-master:/docusaurus/website
    environment:
      - TZ=Asia/Shanghai
      - AUTO_UPDATE=false
      - WEBSITE_NAME=website
      - RUN_MODE=development # development or production
    ports:
      - 3000:80
  1. clone 或 Download Zip 下载本项目源码到本地,重命名为 jetpack-compose-book-master,放到此目录下。此时,目录结构如下
.
├── docker-compose.yml
└── jetpack-compose-book-master
  ├── README.md
  ...
  1. 在此目录下打开终端,执行 docker-compose up -d(部分 linux 平台命令为 docker compose up -d,下面类似)(-d 意为后台运行,如果首次运行希望看到输出,可以不加 -d),稍等几分钟后将会在 http://localhost:3000/ 看到文档
  2. 如果想要停止运行并删除容器,执行 docker-compose down;如果更新了文件,可以使用 docker-compose restart 重启容器;如果想发布生产版本,请将 docker-compose.yml 中的 RUN_MODE 改为 production,并执行 docker-compose up -d 重启容器,执行完成后可在 ./jetpack-compose-book-master/build 下看到生成的静态文件

如果你觉得此项目对你有帮助的话,不妨点个 Star 支持下作者吧~!

贡献者 ❤

版权声明

知识共享许可协议
本作品采用知识共享署名-非商业性使用 2.0 通用许可协议进行许可。

除特别注明外,项目中除了代码部分均采用非商业性使用 2.0 通用 (CC BY-NC 2.0) 进行许可。

您可以自由地:

共享 — 在任何媒介以任何形式复制、发行本作品

演绎 — 修改、转换或以本作品为基础进行创作

但是你必须遵守:

署名 — 您必须给出适当的署名,提供指向本许可协议的链接,同时标明是否(对原始作品)作了修改。您可以用任何合理的方式来署名,但是不得以任何方式暗示许可人为您或您的使用背书。

非商业性使用 — 您不得将本作品用于商业目的。