admibo/mkdocs repository overview

docker run -id --rm -p 11223:80 -v $PWD:/home/ admibo/mkdocs

site_name: BO
copyright: Copyright © 2017 - 2024 MIBO 天下无双
site_author: 'MIBO'
site_description: 'MIBO'
site_url: https://google.com
repo_url: https://codeup.aliyun.com/mibo/markdown
extra:
  social:
    - icon: fontawesome/brands/pied-piper-alt
      link: /feed_rss_created.xml
      name: RSS
  generator: false
  homepage: #
  alternate:
    - name: 说明页
      link: https://hub.docker.com/r/admibo/mkdocs


exclude_docs: |
  api-config.json    # A file with this name anywhere.
  drafts/            # A "drafts" directory anywhere.
  /requirements.txt  # Top-level "docs/requirements.txt".
  *.py               # Any file with this extension anywhere.
  !/foo/example.py   # But keep this particular file.


theme:
  name: material
  favicon: https://wework.qpic.cn/wwpic3az/604287_9ZyT6zeKQAC-KHA_1711206026
  font:
    text: LXGW WenKai Screen
    code: LXGW WenKai Screen
  icon:
    logo: fontawesome/brands/untappd
    repo: fontawesome/brands/github
    edit: fontawesome/regular/pen-to-square
    alternate: fontawesome/brands/the-red-yeti


  language: zh

  features:
  #启用部分后，顶级部分将在上方视口的侧边栏中呈现为组(关闭该功能后、左侧不再啰嗦)
   # - navigation.sections
    #MkDocs 材质会将浏览器的渲染逻辑替换为漂亮的小工具提示
    - content.tooltips
    # 启用每个文章的章节目录
    - toc.follow
    # 把目录合并到左侧
    #- toc.integrate
    - navigation.top
    #启用即时加载后，所有内部链接的点击将被拦截并通过 XHR 调度，而无需完全重新加载页面
    - navigation.instant
    # 页面预读
    - navigation.instant.prefetch

    #启用定位点跟踪后，地址栏中的 URL 将使用内容列表中突出显示的活动定位点自动更新
    - navigation.tracking
    #粘滞选项卡后，导航选项卡将锁定在标题下方,并在向下滚动时始终保持可见。
    - navigation.tabs
    #- navigation.tabs.sticky

    #启用后，整个文档网站中的所有内容选项卡都将链接，并在用户单击选项卡时切换到同一标签，最下 markdown_extensions 搭配
    - content.tabs.link
    # 搜索建议
    - search.suggest
    - search.highlight
    - search.share
    # markdown 代码复制
    - content.code.copy



extra_css:
  - https://cdn.bootcdn.net/ajax/libs/lxgw-wenkai-screen-webfont/1.7.0/style.min.css



markdown_extensions:
  - toc:
      permalink: true
  - md_in_html
  - smarty:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: false
  - footnotes
  - meta
  - def_list
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.tasklist:
        custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.smartsymbols
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
      pygments_lang_class: true
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list

plugins:
  - rss:
      match_path: .*
      categories:
        - categories
        - tags
      date_from_meta:
        as_creation: date
        datetime_format: "%Y-%m-%d %H:%M"
        default_timezone: Asia/Shanghai
  - search:
      lang:
        - en```