mkdocs.yml

# Copyright (c) 2022 CSWU-Challenge

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: 东南大学超算平台
site_url: https://CSWU-Challenge.github.io/
site_author: CSWU-Challenge
site_description: >-
  Southeast University HPC platform.

# Repository
repo_name: CSWU-Challeng
repo_url: https://github.com/CSWU-Challenge/CSWU-Challenge.github.io
edit_uri: ""

# Copyright
# copyright: Copyright © 2022 CSWU-Challenge
copyright: Copyright © 2022 CSWU-Challenge

# Configuration
theme:
  name: material
  custom_dir: material

  # Static files
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  # Necessary for search to work properly
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: zh
  features:
    - content.code.annotate
    # - content.tabs.link
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/sticky-note
      abstract: fontawesome/solid/book
      info: fontawesome/solid/info-circle
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/question-circle
      warning: fontawesome/solid/exclamation-triangle
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left

# Plugins
plugins:
  - search
  - redirects:
      redirect_maps:
        changelog/insiders.md: insiders/changelog.md
        reference/meta-tags.md: reference/index.md
        reference/variables.md: https://mkdocs-macros-plugin.readthedocs.io/
        sponsorship.md: insiders/index.md
        upgrading.md: upgrade.md
  - minify:
      minify_html: true

# Customization
extra:
  analytics:
    provider: google
    property: G-7Y7KMG2XPN
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CSWU-Challeng/CSWU-Challenge.github.io

# Other java
extra_javascript:
    - '//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js'
    - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Wiki:
    - 超算竞赛快速入门: wiki/ASC-introduction.md
    - Linux基础教程: wiki/Linux-base.md
    - conda与pip基础: wiki/conda&pip_base.md
    - 如何写Proposal: wiki/Proposal-writing.md
    - VIM指令入门: wiki/vimtutor.md
    - PyTorch模型优化思路: wiki/pytorch-opt.md
    - TensorFlow模型优化思路: wiki/tensorflow-opt.md
    - Latex环境配置及编译优化: wiki/latex-manual.md
    - c++并行编程入门: wiki/parallel_coding.md
    - 从内存到屏幕：GUI 显示手段的进化史: wiki/how-gui-work.md
    - cuda编程(待完善): wiki/cuda-project.md
  - High Light: page/high-light.md
  - Contirbutor: page/contributor.md
  - How-To: page/to-contributors.md
  - Download: page/Download.md





  #- Getting started:
  #  - Installation: getting-started.md
  #  - Creating your site: creating-your-site.md
  #  - Publishing your site: publishing-your-site.md
  #  - Customization: customization.md
  #  - Browser support: browser-support.md
  #  - Alternatives: alternatives.md
  #  - License: license.md
  #  - Changelog:
  #    - changelog/index.md
  #    - How to upgrade: upgrade.md
  #- Setup:
  #  - Changing the colors: setup/changing-the-colors.md
  #  - Changing the fonts: setup/changing-the-fonts.md
  #  - Changing the language: setup/changing-the-language.md
  #  - Changing the logo and icons: setup/changing-the-logo-and-icons.md
  #  - Ensuring data privacy: setup/ensuring-data-privacy.md
  #  - Setting up navigation: setup/setting-up-navigation.md
  #  - Setting up site search: setup/setting-up-site-search.md
  #  - Setting up site analytics: setup/setting-up-site-analytics.md
  #  - Setting up social cards: setup/setting-up-social-cards.md
  #  - Setting up tags: setup/setting-up-tags.md
  #  - Setting up versioning: setup/setting-up-versioning.md
  #  - Setting up the header: setup/setting-up-the-header.md
  #  - Setting up the footer: setup/setting-up-the-footer.md
  #  - Adding a git repository: setup/adding-a-git-repository.md
  #  - Adding a comment system: setup/adding-a-comment-system.md
  #  - Building for offline usage: setup/building-for-offline-usage.md
  #  - Extensions:
  #    - setup/extensions/index.md
  #    - Python Markdown: setup/extensions/python-markdown.md
  #    - Python Markdown Extensions: setup/extensions/python-markdown-extensions.md
  #- Reference:
  #  - reference/index.md
  #  - Abbreviations: reference/abbreviations.md
  #  - Admonitions: reference/admonitions.md
  #  - Annotations: reference/annotations.md
  #  - Buttons: reference/buttons.md
  #  - Code blocks: reference/code-blocks.md
  #  - Content tabs: reference/content-tabs.md
  #  - Data tables: reference/data-tables.md
  #  - Diagrams: reference/diagrams.md
  #  - Footnotes: reference/footnotes.md
  #  - Formatting: reference/formatting.md
  #  - Icons + Emojis: reference/icons-emojis.md
  #  - Images: reference/images.md
  #  - Lists: reference/lists.md
  #  - MathJax: reference/mathjax.md
  #- Insiders:
  #  - insiders/index.md
  #  - Getting started:
  #    - Installation: insiders/getting-started.md
  #    - Changelog: insiders/changelog.md
  #- Blog:
  #  - blog/index.md
  #  - 2021:
  #    - blog/2021/the-past-present-and-future.md
  #    - blog/2021/excluding-content-from-search.md
  #    - blog/2021/search-better-faster-smaller.md