Skip to content

Commit

Permalink
Add mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
ladinesa committed Sep 11, 2024
1 parent e2f90b4 commit d297b1b
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
site_name: Documentation
site_description: |
The documentation for NOMAD simulation parsers
site_author: The NOMAD Authors
repo_url: https://github.com/nomad-coe/simulation-parsers

nav:
- Home: index.md
- Tutorial: tutorial/tutorial.md
- How-to guides:
- Install this Plugin: how_to/install_this_plugin.md
- Use this Plugin: how_to/use_this_plugin.md
- Contribute to this plugin: how_to/contribute_to_this_plugin.md
- Contribute to the documentation: how_to/contribute_to_the_documentation.md
- Explanation: explanation/explanation.md
- Reference: reference/references.md
plugins:
- search
theme:
name: material
palette:
primary: "#2A4CDF"
accent: "#008A67"
font:
text: "Titillium Web"
logo: assets/nomad-plugin-logo.png
favicon: assets/favicon.png
features:
- navigation.instant
custom_dir: docs/theme
markdown_extensions:
- attr_list
- md_in_html
- admonition
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- toc:
permalink: True
- pymdownx.arithmatex:
generic: true
- attr_list
- mkdocs-click
- pymdownx.extra
extra:
generator: false
homepage: https://nomad-lab.eu
use_directory_urls: false
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascript.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

0 comments on commit d297b1b

Please sign in to comment.