Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added config / docs #17

Merged
merged 1 commit into from
Apr 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
site_name: Reusable Components for Jetpack Compose
site_description: 'A collection of reusable components for Jetpack Compose'
site_author: 'Mohsen'
site_url: 'https://github.com/LinX64/Reusable'
edit_uri: 'tree/main/docs/'
remote_branch: gh-pages

# Repository
repo_name: 'Reusable Components for Jetpack Compose'
repo_url: https://github.com/LinX64/Reusable

theme:
name: material
palette:
primary: white
accent: red
icon:
repo: fontawesome/brands/github
font:
text: 'Roboto'
code: 'JetBrains Mono'
features:
- content.action.edit
- content.code.copy
- content.tabs.link

plugins:
- search

markdown_extensions:
# Admonitions
- admonition
- pymdownx.details

# Code highlight
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences

# Tabs
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true

- toc:
permalink: true

# For images
- attr_list
- md_in_html

# Navigation
nav:
- 'Overview': index.md
- 'How to use?':
- 'Gradle Plugin': use/using-gradle-plugin.md
- 'CLI': use/using-cli.md
- 'Library': use/using-utility-as-library.md