diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000..8c344ef Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/nomad-logo.png b/docs/assets/nomad-logo.png new file mode 100644 index 0000000..3a1282f Binary files /dev/null and b/docs/assets/nomad-logo.png differ diff --git a/docs/index.md b/docs/index.md index 5fe9920..c258b1f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,8 @@ hide: toc --- -# pynxtools-em documentation +# Documentation for pynxtools-em + pynxtools-em is a free and open-source data software for creating standardized semantic serializations of electron microscopy data and metadata for research data management using NeXus, implemented with the goal to make scientific research data FAIR (findable, accessible, interoperable and reusable). pynxtools-em, which is a plugin for pynxtools, provides a tool for reading data from various proprietary and open data formats from technology partners and the wider electron microscopy community and standardizing it such that it is compliant with the NeXus application definition NXem. @@ -64,4 +65,8 @@ for the respective file formats of technology partners of the electron microscop

Project and community

+ + +Any questions or suggestions? [Get in touch!](https://www.fair-di.eu/fairmat/about-fairmat/team-fairmat) + [The work is funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – 460197019 (FAIRmat)](https://gepris.dfg.de/gepris/projekt/460197019?language=en). diff --git a/docs/theme/partials/header.html b/docs/theme/partials/header.html new file mode 100644 index 0000000..5b091f3 --- /dev/null +++ b/docs/theme/partials/header.html @@ -0,0 +1,86 @@ +{#- + This file was automatically generated - do not edit +-#} +{% set class = "md-header" %} +{% if "navigation.tabs.sticky" in features %} + {% set class = class ~ " md-header--lifted" %} +{% endif %} +
+ + {% if "navigation.tabs.sticky" in features %} + {% if "navigation.tabs" in features %} + {% include "partials/tabs.html" %} + {% endif %} + {% endif %} +
\ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml index 6541d31..6c218e5 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,7 +1,10 @@ site_name: pynxtools-em site_description: | The documentation for the pynxtools-em plugin -site_author: The FAIRmat authors +site_author: The NOMAD authors +repo_url: https://github.com/FAIRmat-NFDI/pynxtools-em +edit_uri: "" + nav: - Home: index.md - Tutorials: @@ -21,11 +24,26 @@ nav: - reference/vemd.md - reference/apex.md - reference/nion.md +plugins: + - search + - macros: + module_name: pynxtools_em/mkdocs + theme: name: material + palette: + primary: '#2A4CDF' + accent: '#008A67' + font: + text: 'Titillium Web' + logo: assets/nomad-logo.png + favicon: assets/favicon.png features: + - navigation.instant - content.code.copy - content.code.annotate + custom_dir: docs/theme + markdown_extensions: - attr_list - md_in_html @@ -40,16 +58,24 @@ markdown_extensions: - pymdownx.arithmatex: generic: true - pymdownx.emoji + - mkdocs-click - pymdownx.extra - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format + +extra: + generator: false + homepage: https://nomad-lab.eu + use_directory_urls: false -plugins: - - search - - macros: - module_name: docs/macros + extra_css: - - stylesheets/extra.css \ No newline at end of file + - 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 diff --git a/docs/macros.py b/pynxtools_em/mkdocs.py similarity index 100% rename from docs/macros.py rename to pynxtools_em/mkdocs.py