Skip to content

Commit d8d95e6

Browse files
committed
Initial google codelabs setup
1 parent 6dff8e7 commit d8d95e6

File tree

4 files changed

+84
-2
lines changed

4 files changed

+84
-2
lines changed

.github/workflows/build-docs.yml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build documentation
1+
name: Build and Deploy Writerside + CodeLabs
22

33
on:
44
push:
@@ -23,6 +23,17 @@ jobs:
2323
with:
2424
fetch-depth: 0
2525

26+
# Step to Install claat
27+
- name: Install claat tool
28+
run: go install github.com/googlecodelabs/tools/claat@latest
29+
30+
# Step to Generate CodeLab HTML Files
31+
- name: Generate CodeLabs content
32+
run: |
33+
mkdir -p codelabs
34+
claat export codelabs/workshop/workshop-codelab.md -o codelabs-generated
35+
36+
# Writerside build step
2637
- name: Build docs using Writerside Docker builder
2738
uses: JetBrains/writerside-github-action@v4
2839
with:
@@ -52,9 +63,13 @@ jobs:
5263
with:
5364
name: docs
5465

55-
- name: Unzip artifact
66+
- name: Unzip Writerside artifact
5667
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
5768

69+
# Inject CodeLab HTML into Writerside docs
70+
- name: Copy CodeLabs to Writerside output
71+
run: cp -R codelabs-generated/* dir/
72+
5873
- name: Setup Pages
5974
uses: actions/[email protected]
6075

.idea/codeStyles/Project.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

codelabs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Codelabs
2+
3+
Codelabs are interactive tutorials that run in the browser. This directory contains the source files for
4+
the [Google codelabs](https://github.com/googlecodelabs/tools).

codelabs/workshop/workshop-codelab.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
author: Igor Karenkov
2+
summary: Get known with Modo library for navigation in Jetpack Compose
3+
id: modo-get-started-codelab
4+
environments: Android
5+
status: Published
6+
feedback link: https://github.com/ikarenkov/Modo/issues
7+
8+
# Modo - get started Workshop
9+
10+
## Welcome to Modo Workshop
11+
12+
This workshop will guide you through the basics of Modo library for navigation in Jetpack Compose.
13+
14+
At the end of this workshop you will have a good sample application with Modo navigation that covers common use cases that can be found in real-world
15+
applications.
16+
17+
You will learn:
18+
19+
1. Core concepts of Modo
20+
2. How to setup Modo in your project
21+
3. How to use Modo for stack navigation
22+
4. How to use Modo for tab navigation
23+
5. How to use Modo for navigation inside flow
24+
6. How to use Modo for dialogs
25+
7. How to use Modo with ViewModel and DI
26+
27+
## Core concepts
28+
29+
Please, follow this [link](https://ikarenkov.github.io/Modo/core-concepts.html) to learn more about core concepts of Modo library.
30+
31+
Make sure that you know that:
32+
33+
1. Navigation is defined by state
34+
2. To update state you need to dispatch an action
35+
36+
## Library setup
37+
38+
TODO
39+
40+
## Stack Navigation
41+
42+
TODO
43+
44+
## Tab Navigation
45+
46+
TODO
47+
48+
## Navigation inside flow
49+
50+
TODO
51+
52+
## Dialogs
53+
54+
TODO
55+
56+
## ViewModel and DI
57+
58+
TODO
59+
60+
## Conclusion
61+
62+
TODO

0 commit comments

Comments
 (0)