coco
88 lines
2.5 KiB
YAML
88 lines
2.5 KiB
YAML
# pip install mkdocs mkdocs-material
|
|
# mkdocs serve
|
|
# mkdocs gh-deploy
|
|
|
|
site_name: Voyager
|
|
repo_name: Voyager
|
|
repo_url: https://github.com/adrielcafe/voyager
|
|
site_description: 🛸 A pragmatic navigation library for Jetpack Compose"
|
|
remote_branch: gh-pages
|
|
|
|
#copyright: 'Copyright © '
|
|
|
|
theme:
|
|
name: 'material'
|
|
logo: 'media/icon/logo.png'
|
|
favicon: 'media/icon/logo.png'
|
|
palette:
|
|
- media: '(prefers-color-scheme: light)'
|
|
scheme: default
|
|
primary: 'cyan'
|
|
accent: 'deep-purple'
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: '(prefers-color-scheme: dark)'
|
|
scheme: slate
|
|
primary: 'black'
|
|
accent: 'blue-grey'
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search
|
|
# - minify:
|
|
# minify_html: true
|
|
|
|
markdown_extensions:
|
|
- smarty
|
|
- codehilite:
|
|
guess_lang: false
|
|
- footnotes
|
|
- meta
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.magiclink
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences
|
|
- pymdownx.emoji
|
|
- pymdownx.details
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- admonition
|
|
|
|
nav:
|
|
- 'Overview': index.md
|
|
- 'Setup': setup.md
|
|
- 'Navigation': navigation/index.md
|
|
- 'Nested navigation': navigation/nested-navigation.md
|
|
- 'Multi-module navigation': navigation/multi-module-navigation.md
|
|
- 'Navigation extensions':
|
|
- 'BottomSheet navigation': navigation/bottomsheet-navigation.md
|
|
- 'Tab navigation': navigation/tab-navigation.md
|
|
- 'ScreenModel':
|
|
- 'Overview': screenmodel/index.md
|
|
- 'Coroutines integration': screenmodel/coroutines-integration.md
|
|
- 'RxJava integration': screenmodel/rxjava-integration.md
|
|
- 'LiveData integration': screenmodel/livedata-integration.md
|
|
- 'Hilt integration': screenmodel/hilt-integration.md
|
|
- 'Koin integration': screenmodel/koin-integration.md
|
|
- 'Kodein integration': screenmodel/kodein-integration.md
|
|
- 'Android ViewModel': android-viewmodel/index.md
|
|
- 'ViewModel KMP': android-viewmodel/viewmodel-kmp.md
|
|
- 'Stack API': stack-api.md
|
|
- 'State restoration': state-restoration.md
|
|
- 'Transitions': transitions-api.md
|
|
- 'Lifecycle': lifecycle.md
|
|
- 'Back press': back-press.md
|
|
- 'Deep links': deep-links.md
|
|
- 'Migration to 1.0.0': migration-to-1.0.0.md
|
|
- 'Faq': faq.md
|
|
- 'Community Projects': community-projects.md |