Skip to content

Commit

Permalink
Add mkdocs configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
MishimaHaruna committed Jan 11, 2024
1 parent 2a2fd23 commit c1bf662
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.venv
13 changes: 13 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
},
"yaml.customTags": [
"!ENV scalar",
"!ENV sequence",
"!relative scalar",
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
}
Binary file added docs/assets/Hercules48.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
copyright: Copyright © 2013-2024 Hercules Dev Team
edit_uri: edit/master/docs/
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/HerculesWS/Hercules
- icon: fontawesome/brands/discord
link: https://board.herc.ws/discord/invite/general/
markdown_extensions:
- admonition
- attr_list
- def_list
- md_in_html
- pymdownx.critic
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
linenums_style: pymdownx-inline
pygments_lang_class: true
use_pygments: true
- pymdownx.superfences:
custom_fences:
- class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
name: mermaid
preserve_tabs: true
- tables
repo_url: https://github.com/HerculesWS/hercules-docs
site_name: Hercules Docs
theme:
features:
- content.action.edit
- content.action.view
- content.code.copy
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- toc.follow
- toc.integrate
favicon: assets/Hercules48.png
logo: assets/Hercules48.png
name: material
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

0 comments on commit c1bf662

Please sign in to comment.