Skip to content

Commit

Permalink
update mkdocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
joelkanyi committed Jun 7, 2024
1 parent 419e9c3 commit b69d83d
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 67 deletions.
File renamed without changes.
20 changes: 0 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,26 +128,6 @@ The library works well in one orientation. If you rotate the device, the signatu
</br>

### Demo
##### Android
![type:video](../assets/android_demo.gif)
</br>

##### iOS
![type:video](../assets/ios_demo.gif)
</br>

##### Desktop
![type:video](../assets/desktop_demo.gif)
</br>

##### Web Wasm
![type:video](../assets/demo_web_wasm.gif)
</br>

##### Web JS
![type:video](../assets/web_js_demo.gif)
</br>

#### License
```xml
Expand Down
78 changes: 31 additions & 47 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,62 +9,46 @@ edit_uri: "tree/main/docs/"
docs_dir: docs
remote_branch: gh-pages

nav:
- 'Overview': index.md
- 'Getting Started': get-started.md
- 'Usage': usage.md
- 'API Reference': site/api
- 'Demo': samples.md
- 'License': license.md

theme:
name: material
features:
- navigation.expand
icon:
repo: fontawesome/brands/github
name: 'material'
language: 'en'
palette:
# Palette toggle for light mode
- scheme: default
media: "(prefers-color-scheme: light)"
primary: 'teal'
accent: 'teal'
toggle:
icon: material/weather-night
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- scheme: slate
media: "(prefers-color-scheme: dark)"
primary: 'light blue'
accent: 'light blue'
toggle:
icon: material/weather-sunny
icon: material/brightness-4
name: Switch to light mode

plugins:
- macros # for variables like git.tag (requires mkdocs-macros-plugin)
- search

markdown_extensions:
- admonition # for info/warn/tip sections
- attr_list # for anchors in definition lists
- def_list # for definition lists (stomp config)
- footnotes
- toc:
permalink: true
- pymdownx.emoji
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.tabbed

nav:
# - 'Overview': index.md
- 'Getting Started': getting-started.md
- 'Usage': usage.md
- 'API Reference': api/
- 'Samples': samples.md
# - 'License': license.md

extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/_joelkanyi
name: "Joel on Twitter"
versions:
jackson: 2.17.1
ktor: 2.3.11
kotlinxSerialization: 1.6.3
moshi: 1.15.1
tyrus: 2.1.5
plugins:
- search

copyright: Copyright &copy; 2023 - 2024 Joel Kanyi
# Extensions
markdown_extensions:
- admonition
- attr_list
- codehilite:
guess_lang: false
- footnotes
- toc:
permalink: true
- pymdownx.betterem
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.details
- pymdownx.tilde

0 comments on commit b69d83d

Please sign in to comment.