How to Edit mkdocs.yml file¶

Student template¶

mkdocs.yml

# Replace the text below to customize your site
site_name: Your name - Fab Academy
site_description: Fab Academy documentation site for Your Name
site_author: Your name
copyright: Copyright 2023 Your name - Creative Commons Attribution Non Commercial

site_url: http://fibasile.fabcloud.io/fabacademy-student-template/

extra:
  # Set your own social media below (or remove)
  social:
    # For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/fabacademany
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/fabacademany
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/fabacademany
    - icon: fontawesome/brands/linkedin
      link: "https://linkedin.com/in/academany"

theme:
  name: material
  palette:
    # try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
    primary: deep
    accent: indigo
  font:
    # See available fonts at https://fonts.google.com/
    text: Ubuntu
    code: Ubuntu Mono
  icon:
    logo: material/school
  favicon: images/favicon.svg
  features:
    - navigation.tabs
    - navigation.instant

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
      # Read more: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, False]

markdown_extensions:
  - extra
  - smarty
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true

this site yml at the first class¶

mkdocs.yml

# Replace the text below to customize your site
site_name: FabLab Kannai - Fab Academy 2026 # サイトの名前
site_description: Fab Academy documentation site for FabLab Kannai  # サイトの説明
site_author: Yuichi TAMIYA  # サイトの作者名
copyright: Copyright 2026 Yuichi TAMIYA - Creative Commons Attribution Non Commercial  # 著作権表示 フッターに表示される

site_url: https://academany.fabcloud.io/fabacademy/2026/labs/kannai/site

# 追加のCSSファイルを指定
extra_css:
  - stylesheets/extra.css  # 追加のカスタムCSSファイルを適用
  - stylesheets/svg.css # SVGを使うためのCSSファイル

# 分数表記の為に追加
extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js



extra:
  # Set your own social media below (or remove)
  social:
    # For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/fabacademany
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/fabacademany
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/fabacademany
    - icon: fontawesome/brands/linkedin
      link: "https://linkedin.com/in/academany"

# テーマの設定
theme:
  name: material
  #palette:
  #  # try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
  #  primary: deep
  #  accent: indigo
  font: # See available fonts at https://fonts.google.com/
    text: SemiBold 600  # テキストフォントの設定
    code: Ubuntu Mono  # コードフォントの設定
  logo: images/logo2022-tate-g.png  # ロゴアイコンの設定
  icon:
    favicon: images/favicon.svg # ファビコンの設定　　https://favicon-generator.mintsu-dev.com/
  features:
    - navigation.tabs  # ナビゲーションをタブで表示
    - navigation.instant  # ナビゲーションが即座に切り替わる機能
#  - navigation.top  # ナビゲーションバーをトップに表示（コメントアウト）
#  - navigation.sections  # ナビゲーションをセクションで分ける（コメントアウト）

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
      # Read more: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, False]

markdown_extensions:
# included in the student template
  - extra #テーブル（|で区切る形式）,定義リスト（:を使ったリスト）,フットノート（脚注の追加）
  - smarty #文章中の記号をスマートな記号に変換 -- をエムダッシュ（—）に変換、" を「スマートクォート」に変換
  #- admonition #注意や補足など、特定の内容を枠で目立たせることができます。
  - codehilite: #コードブロックにシンタックスハイライトを適用します。
      guess_lang: false #言語の自動判別を無効にする（明示的に言語を指定する必要がある）
  - toc: #目次（Table of Contents）を生成
      permalink: true #各見出しにリンクを追加して、簡単にアクセスできるようにする

# added
  - pymdownx.tabbed:
      alternate_style: true #これがないとlocalではtabが動くが、サイトでは動かない
      #pip install --upgrade mkdocs-material pymdown-extensions これでlocalとサイト両方で動くようになった
  - pymdownx.superfences #linenumsに必要

  - pymdownx.highlight:
  #    linenums: true #コメントアウトのままで必要な時にだけ都度linenums="1"と書けばよい

  - admonition
  - pymdownx.details #admonitionの折りたたみに必要
  - attr_list #![](path/to/image.jpg){width=300}で表示される大きさを変える