diff --git a/docs/proteus_framework.md b/docs/proteus_framework.md index 47f76d4..9912d6f 100644 --- a/docs/proteus_framework.md +++ b/docs/proteus_framework.md @@ -1,3 +1,7 @@ +--- +title: MORS in the PROTEUS framework +--- +

@@ -7,14 +11,11 @@

-MORS is the stellar rotation and evolution module of PROTEUS (/ˈproʊtiəs, PROH-tee-əs), a modular Python framework that simulates the coupled evolution of the atmospheres and interiors of rocky planets and exoplanets. A schematic of PROTEUS components and corresponding modules can be found below. Its coupling to MORS is explained [here](Explanations/proteus.md). -
-
-You can find the documentation of each PROTEUS module in the sidebar. -
+ +MORS is the **stellar rotation and evolution module** of [PROTEUS](https://proteus-framework.org/PROTEUS) (/ˈproʊtiəs/, PROH-tee-əs), a modular Python framework for the coupled evolution of the atmospheres and interiors of rocky planets and exoplanets. A schematic of PROTEUS components and corresponding modules can be found below. Click any module in the diagram to open its documentation, or navigate to it from the sidebar.
-

- PROTEUS schematicPROTEUS schematic
- Schematic of PROTEUS components and corresponding modules. -

\ No newline at end of file +PROTEUS module schematic (light mode) +PROTEUS module schematic (dark mode) + +

Schematic of PROTEUS components and corresponding modules.

\ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..af97b0d --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,20 @@ +.mod-diagram { + width: 100%; + height: auto; + aspect-ratio: 12.1 / 9; /* specific aspect ratio for the module diagram */ + display: none; +} +/* Light mode: show light diagram */ +[data-md-color-scheme="default"] .mod-diagram--light { + display: block; +} + +/* Dark mode: show dark diagram (Material's default dark scheme is "slate") */ +[data-md-color-scheme="slate"] .mod-diagram--dark { + display: block; +} + +/* Remove underline from links that contain only an image */ +.md-typeset p a:has(> img) { + text-decoration: none; +} \ No newline at end of file diff --git a/docs/stylesheets/footnotes.css b/docs/stylesheets/footnotes.css index f3729cf..20bb8fb 100644 --- a/docs/stylesheets/footnotes.css +++ b/docs/stylesheets/footnotes.css @@ -18,12 +18,4 @@ font-size: 1em !important; } -/* reduce space under the page title */ -.md-typeset h1 { - margin-bottom: 0.2rem; /* try 0, 0.2rem, 0.5rem */ -} -/* optionally reduce any top margin on the first image */ -.md-typeset h1 + p img { - margin-top: 0; -} diff --git a/mkdocs.yml b/mkdocs.yml index 80c4bc0..842a5f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,10 +78,9 @@ nav: - 🔗 Zalmoxis: https://proteus-framework.org/Zalmoxis/ - 🔗 Aragog: https://proteus-framework.org/aragog/ - 🔗 SPIDER: https://proteus-framework.org/SPIDER/ - - 🔗 Atmodeller: https://atmodeller.readthedocs.io/en/latest/ - - 🔗 FastChem: https://newstrangeworlds.github.io/FastChem/ - - 🔗 PLATON: https://platon.readthedocs.io/en/latest/ - - 🔗 SOCRATES: https://github.com/FormingWorlds/SOCRATES/ + - 🔗 Atmodeller: https://github.com/FormingWorlds/Atmodeller/ + - 🔗 FastChem: https://github.com/FormingWorlds/FastChem/ + - 🔗 SOCRATES: https://proteus-framework.org/SOCRATES/ # footer: extra: @@ -139,6 +138,7 @@ theme: extra_css: - stylesheets/proteus_theme.css - stylesheets/footnotes.css + - stylesheets/extra.css markdown_extensions: - admonition