Skip to content

Commit

Permalink
mkdocs change
Browse files Browse the repository at this point in the history
  • Loading branch information
taddyb committed Oct 16, 2023
1 parent c1ef6d7 commit d8c231f
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
17 changes: 17 additions & 0 deletions 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.
51 changes: 51 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
site_name: MHPI Lab group
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- toc.integrate
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
primary: teal
accent: purple
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
primary: teal
accent: lime

#plugins:
# - social
extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/mhpi

#markdown_extensions:
# - pymdownx.highlight:
# anchor_linenums: true
# - pymdownx.inlinehilite
#- pymdownx.snippets
#- admonition
# - pymdownx.arithmatex:
# generic: true
# - footnotes
# - pymdownx.details
# - pymdownx.superfences
# - pymdownx.mark
# - attr_list
# - pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg

0 comments on commit d8c231f

Please sign in to comment.