Skip to content

Commit 32376c4

Browse files
levinzonrlevinzonr
committed
docs: Update Readme, add logos and icons and prepare structure
1 parent 494d0ea commit 32376c4

File tree

10 files changed

+104
-30
lines changed

10 files changed

+104
-30
lines changed

‎.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
restore-keys: |
3030
mkdocs-material-
3131
- run: |
32-
./gradlew dokkaHtmlMultiModule
33-
mv build/dokka/htmlMultiModule docs/api
32+
chmod +x ./generate_docs.sh
33+
./generate_docs.sh
3434
- run: pip install mkdocs-material
3535
- run: mkdocs gh-deploy --force

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,10 @@
1818
.cxx
1919
local.properties
2020
/build-logic/convention/build/
21+
22+
23+
# Documentation not to be modified by hand (pulled from root project)
24+
docs/index.md
25+
docs/changelog.md
26+
docs/contributing.md
27+
docs/api/*

‎README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
# Mosaic
2-
Collection of UI components and utilities for Jetpack Compose
3-
4-
## TODOS
5-
- [x] Project setup
6-
- [x] Convention Plugins
7-
- [ ] Sonarqube
8-
- [x] CI/CD and PR validation, Spotless, Detekt, tests
9-
- [ ] Release management,
10-
- [x] Maven Publish
11-
- [ ] Changelog
12-
- [ ] Tags & Releases
13-
- [x] Documentation setup
142

3+
4+
<p align="center">
5+
<img src="docs/assets/logo.svg" alt="Mosaic Logo" width="300"/>
6+
</p>
7+
8+
<p align="center" style="font-size: 15px;">
9+
<strong>Mosaic</strong> is acollection of Jetpack Compose UI components and utilities. It is designed to accelerate the development process by providing a rich set of tools and components that are ready to use out of the box. These components are highly customizable ensuring to fit in your use case.
10+
</p>
11+
12+
13+
## Libraries
14+
15+
### Slider
16+
Mosaic Slider is a highly customizable slider component that allows precise customization of values distribution and disabled ranges. Its API is similar to Material sliders, making it easy to integrate into existing projects.
17+
18+
19+
20+
## Contributing
21+
22+
We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for more details.
23+
24+
## License
25+
26+
Mosaic is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
27+
```

‎build-logic/convention/build.gradle.kts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ dependencies {
1212
compileOnly(lib.android.gradle.plugin)
1313
}
1414

15+
kotlin {
16+
jvmToolchain(17)
17+
}
18+
1519
gradlePlugin {
1620
/**
1721
* Register convention plugins so they are available in the build scripts of the application

‎docs/assets/favicon.png

15 KB
Loading

‎docs/assets/logo.svg

Lines changed: 4 additions & 0 deletions
Loading

‎docs/slider.md

Whitespace-only changes.

‎docs/stylesheets/extra.css

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,47 @@
11
:root {
2-
--md-primary-fg-color: #FFFF00;
3-
--md-primary-fg-color--light: #464A4D;
4-
--md-primary-fg-color--dark: #464A4D;
5-
--md-primary-bg-color: #464A4D;
6-
--md-primary-bg-color--light: #464A4D;
7-
8-
// Accent color shades
9-
--md-accent-fg-color: #000000;
10-
--md-accent-fg-color--transparent: #464A4D;
11-
--md-accent-bg-color: #464A4D;
12-
--md-accent-bg-color--light: #464A4D;
13-
}
142

3+
/* Primary color shades - NavBar */
4+
--md-primary-fg-color: black;
5+
--md-primary-bg-color: white;
156

16-
:root>* {
17-
--md-typeset-a-color: #656A6D;
7+
/* Accent color shades - Hover effects */
8+
--md-accent-fg-color: yellow;
9+
--md-accent-fg-color--transparent: white;
10+
--md-accent-bg-color: white;
1811
}
12+
13+
:root > * {
14+
/* background color */
15+
--md-default-bg-color: #343434;
16+
17+
/* default text color */
18+
--md-typeset-color: white;
19+
20+
/* color for links */
21+
--md-typeset-a-color: yellow;
22+
23+
24+
--md-footer-fg-color: yellow;
25+
--md-footer-bg-color: black;
26+
27+
/* color for markdown code blocks */
28+
--md-code-fg-color: yellow;
29+
--md-code-bg-color: #2B2B2B;
30+
31+
/* color for markdown headers */
32+
--md-default-fg-color--light: white;
33+
34+
/* color for code highlighting, works kinda like Dracula Theme */
35+
--md-code-hl-number-color: #A9B7C5;
36+
--md-code-hl-special-color: #A9B7C5;
37+
--md-code-hl-function-color: #A9B7C5;
38+
--md-code-hl-constant-color: #A9B7C5;
39+
--md-code-hl-keyword-color: #CB7832;
40+
--md-code-hl-string-color: #6A8759;
41+
--md-code-hl-name-color: #A9B7C5;
42+
--md-code-hl-operator-color: #A9B7C5;
43+
--md-code-hl-punctuation-color: #A9B7C5;
44+
--md-code-hl-comment-color: #6A8759;
45+
--md-code-hl-generic-color: #A9B7C5;
46+
--md-code-hl-variable-color: #A9B7C5;
47+
}

‎generate_docs.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# Copy the README.md And CHANGELOG.md to their respective tabs in MKDocs
3+
cp README.md docs/index.md
4+
cp CHANGELOG.md docs/changelog.md
5+
6+
# replace the relative links in the README.md with the absolute links
7+
sed -i 's/](docs\//](/g' docs/index.md
8+
9+
# Generate Dokka documentation for the project
10+
./gradlew dokkaHtmlMultiModule
11+
mv build/dokka/htmlMultiModule docs/api

‎mkdocs.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
site_name: My Docs
1+
site_name: Mosaic
22
extra_css:
33
- stylesheets/extra.css
44
theme:
5+
logo: assets/logo.svg
6+
favicon: assets/favicon.png
57
name: material
8+
font:
9+
text: 'Monument Grotesk'
610
palette:
711
primary: custom
8-
912
nav:
13+
- 'Slider': slider.md
1014
- 'API': api/
15+
- 'Changelog': changelog.md
16+
- 'Contributing': contributing.md

0 commit comments

Comments
 (0)