refactor from sphinx to mkdocs for added functionality and ease of use

This commit is contained in:
rskntroot
2024-06-09 06:09:09 +00:00
parent 317e362366
commit 45034f48c3
15 changed files with 619 additions and 475 deletions

59
mkdocs/mkdocs.yml Normal file
View File

@@ -0,0 +1,59 @@
site_name: Rskio
site_url: https://rskio.com/
repo_name: rskntroot/rskio
repo_url: https://github.com/rskntroot/rskio
theme:
name: material
features:
- navigation.instant
icon:
admonition:
note: fontawesome/solid/note-sticky
abstract: fontawesome/solid/book
info: fontawesome/solid/circle-info
success: fontawesome/solid/check
question: fontawesome/solid/circle-question
failure: fontawesome/solid/bomb
danger: fontawesome/solid/skull
bug: fontawesome/solid/robot
example: fontawesome/solid/flask
quote: fontawesome/solid/quote-left
repo: fontawesome/brands/github
palette:
# Palette toggle for dark mode
- scheme: slate
primary: black
toggle:
icon: material/weather-sunny
name: Switch to light mode
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
markdown_extensions:
- admonition
- abbr
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
watch:
- includes
extra:
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.