mkdocs.yml

site_name: MFEM
site_url: https://mfem.org
docs_dir: 'src'

markdown_extensions:
- extra  # allow markdown in <div markdown="1">
- fenced_code  # GitHub style code blocks, e.g. ```python, see https://highlightjs.readthedocs.org/en/latest/css-classes-reference.html for a list of languages
- footnotes
- attr_list  # Allow us to add link attributes

repo_url: https://github.com/mfem/mfem
remote_name: origin

# pages starting with '_' are hidden from the menu

nav:
- Home: index.md
- Features: features.md
- Examples:
  - 'Example Codes': examples.md
  - 'Electromagnetics': electromagnetics.md
  - 'Fluid Dynamics': fluids.md
  - 'Meshing': meshing-miniapps.md
  - 'NURBS Discretization': nurbs.md
  - 'Automatic Differentiation': autodiff.md
  - 'Tools': tools.md
  - 'Toys': toys.md
- Documentation:
  - 'Getting Started': getting-started.md
  - '_Building MFEM': building.md
  - '_Serial Tutorial': serial-tutorial.md
  - '_Parallel Tutorial': parallel-tutorial.md
  - '_Code Overview': code-overview.md
  - '_Tesla Notes': tesla-notes.md
  - '_Maxwell Notes': maxwell-notes.md
  - 'HowTo Articles': howto/howto-index.md
  - 'Finite Elements': fem.md
  - '_Primal and Dual Vectors': pri-dual-vec.md
  - '_Bilinear Form Integrators': bilininteg.md
  - '_Linear Form Integrators': lininteg.md
  - '_Coefficients': coefficient.md
  - '_Nonlinear Form Integrators': nonlininteg.md
  - '_Linear Interpolators': lininterp.md
  - '_Weak Formulations': fem_weak_form.md
  - '_Boundary Conditions': fem_bc.md
  - 'Performance': performance.md
  - '_High Performance Templated Code': tperformance.md
  - 'GPU Support': gpu-support.md
  - 'Mesh Formats': mesh-formats.md
  - '_Mesh Format v1.0': mesh-format-v1.0.md
  - '_Mesh Format v1.x': mesh-format-v1.x.md
  - 'Doxygen': dox.md
  - 'Publications': publications.md
  - 'About': about.md
  - '🔎 Search...': search.md
- Community:
  - 'News': news.md
  - 'Videos': videos.md
  - 'Seminar': seminar.md
  - 'Workshop': workshop.md
  - '_Workshop23': workshop23.md
  - '_Workshop22': workshop22.md
  - '_Workshop21': workshop21.md
  - 'Tutorial': tutorial/index.md
- Gallery: gallery.md
- Download: download.md

theme:
  name: mkdocs  # required. Can be anything as long as custom_dir is set correctly below
  custom_dir: template
  features:
    - search.suggest

extra:
  include_next_prev: false  # turn off next/previous buttons

plugins:
  - search
  - exclude-search:
      exclude:
        # List of pages that will not be searched
        - code-overview.md
        - download.md
        - features.md
        - index.md
        - search.md
        - tperformance.md

# Currently not used
# - doxygen:
#     tryclone: yes
#     packages:
#       - doxygen:
#           url: ../mfem_master
#           config: doc/config.in
#           workdir: .

google_analytics: ['UA-101697-3', 'mfem.org']