Skip to content

Instantly share code, notes, and snippets.

@JeonghunLee
Last active April 23, 2024 01:11
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save JeonghunLee/af471c754ec048bda7a89afb2ebf66af to your computer and use it in GitHub Desktop.
Save JeonghunLee/af471c754ec048bda7a89afb2ebf66af to your computer and use it in GitHub Desktop.
mkdocs.yml
site_name: MyDocs TEST
plugins:
- with-pdf
- search
- mermaid2
- offline
# - pandoc
#
# sudo mkdocs
# sudo apt install pandoc
# sudo apt install texlive-latex-base
#
nav:
- "Home": index.md
- "About": about.md
- "chapter1":
- "1-1" : chaper1/1-1.md
- "1-2" : chaper1/1-2.md
- "chapter2":
- "subchapter" :
- "sub1" : chaper1/1-2.md
- "sub2" : chaper1/1-2.md
theme :
# this is for only material
name: material
language: ko
#
#
#
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
features:
# ony for material
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration-without
#- toc.integrate
- toc.follow
- navigation.instant
- navigation.instant.progress
#- navigation.tabs
#- navigation.sections
- navigation.path
#- navigation.indexes
- navigation.top
- navigation.footer
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.tooltips
- content.code.copy
#
# for material , navigation and toc
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration
# for material
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/
#
markdown_extensions:
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
#
# only material for mermaid
#
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
#
# theam: material
# need to set up with features and scheme and markdown_extensions
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/
#
extra_javascript:
# for math
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment