mkdocs.yml

site_name: free5GC

extra_css:
  - stylesheets/extra.css

repo_name: free5GC
repo_url: https://github.com/free5gc/free5gc
edit_uri: https://github.com/free5gc/free5gc.github.io/blob/main/docs/

extra:
  social:
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/free5gc
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/free5gc/
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/profile.php?id=100086840296930
  generator: false

theme:
  name: material
  logo: assets/icon.png
  favicon: assets/icon.png
  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  locale:
    en
    # analytics: {gtag: ''}
  highlightjs: true
  hljs_languages:
    - yaml
    - django

nav:
  - Home: index.md
  - User Guide: guide/
  - Documents: doc/
  - Tutorials: https://github.com/free5gc/free5GLab
  - Blogs: blog/
  - Supports: support/
  - More:
      - Relavent Publications: publication.md
      - Other Videos: videos.md

markdown_extensions:
  - nl2br
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - tables
  - mdx_math:
      enable_dollar_delimiter: True
  - fenced_code

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML

plugins:
  - search
  - callouts

copyright: |
  Copyright © free5GC a Series of LF Projects, LLC.
  For web site terms of use, trademark policy and other project policies please see https://lfprojects.org.