Skip to content

Commit

Permalink
feat: working on getting the documentation deployed
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelLarkin committed Feb 19, 2024
1 parent df142e0 commit a9de095
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# [mkdocs](https://www.mkdocs.org/)
# pip install --user -r docs/requirements.txt
# mkdocs build
# mkdocs gh-deploy
# mkdocs serve
site_name: Samuel Larkin's Documenation
site_url: https://github.com/SamuelLarkin/config
site_url: https://SamuelLarkin.github.io
repo_url: https://github.com/SamuelLarkin/config
repo_name: SamuelLarkin/config
theme:
Expand All @@ -16,7 +17,7 @@ theme:
toggle:
icon: material/weather-night
name: Switch to light mode

# Palette toggle for light mode
- accent: light blue
scheme: default
Expand All @@ -29,10 +30,11 @@ theme:
- announce.dismiss
highlightjs: true
hljs_languages:
- yaml
- rust
- bash
- go
- python
- rust
- yaml
shortcuts:
help: 191 # ?
next: 78 # n
Expand All @@ -41,19 +43,12 @@ theme:
plugins:
- search
- macros
# - mkdocstrings:
# default_handler: python
# handlers:
# python:
# paths: [everyvoice]
extra:
homepage: https://github.com/SamuelLarkin/config
version:
provider: mike
default: stable
markdown_extensions:
# - mkdocs-typer
# - mkdocs-click
- admonition
# - pymdownx.details
# - pymdownx.superfences
Expand All @@ -63,8 +58,10 @@ nav:
- Home: README.md
- Colors: color.md
- Configuration File Explained: config_files.md
- Miscellaneous: doc.md
- Doc: doc.md
- fzf: fzf.md
- Miscellaneous: doc.md
- nvim: nvim.md
- rsync: rsync.md
- SLURM: slurm.md
- tmux: tmux.md

0 comments on commit a9de095

Please sign in to comment.