Skip to content

Commit

Permalink
docs: add Material for MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
tippfehlr committed Mar 10, 2024
1 parent b4d7c6d commit 8092b7a
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ scripts/
justfile
docker-compose.yaml

# Material for MkDocs
docs/.cache

# yarn v2+:
.pnp.*
.yarn/*
Expand Down
Binary file added docs/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/favicon.ico
Binary file not shown.
17 changes: 17 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
17 changes: 17 additions & 0 deletions docs/docs/index1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
49 changes: 49 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Activity Roles
# site_url: https://tippfehlr.github.io/activity-roles/
repo_name: tippfehlr/activity-roles
repo_url: https://github.com/tippfehlr/activity-roles
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
language: en
# logo: assets/icon.png
favicon: images/favicon.ico
features:
- navigation.instant
- navigation.instant.progress
- navigation.expand
- navigation.indexes
- toc.follow
- search.highlight
- content.action.edit
- content.action.view
icon:
repo: fontawesome/brands/github
plugins:
- search
- social
extra:
analytics:
provider: custom
1 change: 1 addition & 0 deletions docs/overrides/partials/integrations/analytics/custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<script defer data-domain="activity-roles-docs" src="https://plausible.tippfehlr.dev/js/script.js"></script>

0 comments on commit 8092b7a

Please sign in to comment.