Skip to content

Commit

Permalink
fix: update mkdocs & plugins versions
Browse files Browse the repository at this point in the history
  • Loading branch information
sundowndev committed Jul 17, 2022
1 parent 9384ffc commit edd21a2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs==1.2.3 mkdocs-material==8.1.4 mkdocs-minify-plugin==0.5.0
python -m pip install mkdocs==1.3.0 mkdocs-material==8.3.9 mkdocs-minify-plugin==0.5.0
- name: Deploy
run: |
Expand Down
4 changes: 2 additions & 2 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@ yarn lint:fix

## Documentation

We use [mkdocs](https://www.mkdocs.org/) to write our documentation.
We use [mkdocs](https://www.mkdocs.org/) to generate our documentation website.

### Install mkdocs

```shell
python3 -m pip install mkdocs==1.2.3 mkdocs-material==8.1.4 mkdocs-minify-plugin==0.5.0
python3 -m pip install mkdocs==1.3.0 mkdocs-material==8.3.9 mkdocs-minify-plugin==0.5.0
```

### Serve documentation on localhost
Expand Down
14 changes: 12 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,18 @@ theme:
logo: './images/logo_white.svg'
favicon: './images/logo.svg'
palette:
primary: 'blue grey'
accent: 'brown'
- scheme: default
primary: blue grey
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: blue grey
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.tabs.link
extra:
Expand Down

0 comments on commit edd21a2

Please sign in to comment.