From 4a71a09b28dfc222547b2671d620a70ce29b3c4e Mon Sep 17 00:00:00 2001 From: Michel Gabriel Date: Wed, 25 Oct 2023 11:25:15 +0200 Subject: [PATCH 1/3] Rename `.grid` to `.gn-grid` to avoid conflicting classnames, and some additional styling so content doesn't break between columns. --- docs/manual/docs/index.fr.md | 2 +- docs/manual/docs/index.md | 2 +- .../overrides/assets/stylesheets/extra.css | 21 ++++++++++--------- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/manual/docs/index.fr.md b/docs/manual/docs/index.fr.md index a491841fe52..82d06c56a6e 100644 --- a/docs/manual/docs/index.fr.md +++ b/docs/manual/docs/index.fr.md @@ -7,7 +7,7 @@ hide: Bienvenue à GeoNetwork. Cette documentation est organisée en guides spécifiques destinés à différents publics. -
+
:fontawesome-solid-signs-post: [Vue d'ensemble](overview/index.md) diff --git a/docs/manual/docs/index.md b/docs/manual/docs/index.md index 5780bdfdb5e..b634f53ce16 100644 --- a/docs/manual/docs/index.md +++ b/docs/manual/docs/index.md @@ -7,7 +7,7 @@ hide: Welcome to GeoNetwork. This documentation is organized into specific guides targeting different audience. -
+
:fontawesome-solid-signs-post: [Overview](overview/index.md) diff --git a/docs/manual/overrides/assets/stylesheets/extra.css b/docs/manual/overrides/assets/stylesheets/extra.css index 8155e94365e..6717012747c 100644 --- a/docs/manual/overrides/assets/stylesheets/extra.css +++ b/docs/manual/overrides/assets/stylesheets/extra.css @@ -10,43 +10,44 @@ img + em, .browser-border + em, .browser-mockup + em { } /* grid */ -.md-typeset .grid { +.md-typeset .gn-grid { column-count: 2; column-gap: 2em; margin-bottom: 20px; } -.md-typeset .grid dl { +.md-typeset .gn-grid dl { display: grid; grid-template-columns: repeat(auto-fit,minmax(16rem,1fr)); margin: 0; } -.md-typeset .grid.cards dt, .md-typeset .grid.cards dd { +.md-typeset .gn-grid.cards dt, .md-typeset .gn-grid.cards dd { border: 0.05rem solid var(--md-default-fg-color--lightest); border-radius: 0.1rem; display: block; margin: 0; padding: 0.8rem; transition: border .25s,box-shadow .25s; + break-inside: avoid; } -.md-typeset .grid.cards dt { +.md-typeset .gn-grid.cards dt { font-weight: bold; + margin-top: 0.5rem; } -.md-typeset .grid.cards dt .twemoji { +.md-typeset .gn-grid.cards dt .twemoji { margin-right: 5px; } -.md-typeset .grid.cards dd { - margin-bottom: 0.8rem; +.md-typeset .gn-grid.cards dd { margin-top: -1px; } -.md-typeset .grid.cards dd p { +.md-typeset .gn-grid.cards dd p { margin: 0; } @media (max-width: 768px) { - .md-typeset .grid dl { + .md-typeset .gn-grid dl { display: inline-block; margin-bottom: 20px; } - .md-typeset .grid.cards dt, .md-typeset .grid.cards dd { + .md-typeset .gn-grid.cards dt, .md-typeset .gn-grid.cards dd { width: calc(100vw - 1.2rem - 1.2rem); } } From f437bae48d948b62470cb8c8a00d63941c5776bc Mon Sep 17 00:00:00 2001 From: Michel Gabriel Date: Tue, 2 Jan 2024 13:17:26 +0100 Subject: [PATCH 2/3] Add extra style to override the imported styles, revert the new class name: `.gn-grid` -> `.grid` --- docs/manual/docs/index.md | 2 +- .../overrides/assets/stylesheets/extra.css | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/manual/docs/index.md b/docs/manual/docs/index.md index b634f53ce16..5780bdfdb5e 100644 --- a/docs/manual/docs/index.md +++ b/docs/manual/docs/index.md @@ -7,7 +7,7 @@ hide: Welcome to GeoNetwork. This documentation is organized into specific guides targeting different audience. -
+
:fontawesome-solid-signs-post: [Overview](overview/index.md) diff --git a/docs/manual/overrides/assets/stylesheets/extra.css b/docs/manual/overrides/assets/stylesheets/extra.css index 6717012747c..00e914297b0 100644 --- a/docs/manual/overrides/assets/stylesheets/extra.css +++ b/docs/manual/overrides/assets/stylesheets/extra.css @@ -10,17 +10,18 @@ img + em, .browser-border + em, .browser-mockup + em { } /* grid */ -.md-typeset .gn-grid { +.md-typeset .grid { column-count: 2; column-gap: 2em; margin-bottom: 20px; + display: block !important; } -.md-typeset .gn-grid dl { +.md-typeset .grid ul, .md-typeset .grid dl { display: grid; grid-template-columns: repeat(auto-fit,minmax(16rem,1fr)); margin: 0; } -.md-typeset .gn-grid.cards dt, .md-typeset .gn-grid.cards dd { +.md-typeset .grid.cards dt, .md-typeset .grid.cards dd { border: 0.05rem solid var(--md-default-fg-color--lightest); border-radius: 0.1rem; display: block; @@ -29,25 +30,25 @@ img + em, .browser-border + em, .browser-mockup + em { transition: border .25s,box-shadow .25s; break-inside: avoid; } -.md-typeset .gn-grid.cards dt { +.md-typeset .grid.cards dt { font-weight: bold; margin-top: 0.5rem; } -.md-typeset .gn-grid.cards dt .twemoji { +.md-typeset .grid.cards dt .twemoji { margin-right: 5px; } -.md-typeset .gn-grid.cards dd { +.md-typeset .grid.cards dd { margin-top: -1px; } -.md-typeset .gn-grid.cards dd p { +.md-typeset .grid.cards dd p { margin: 0; } @media (max-width: 768px) { - .md-typeset .gn-grid dl { + .md-typeset .grid dl { display: inline-block; margin-bottom: 20px; } - .md-typeset .gn-grid.cards dt, .md-typeset .gn-grid.cards dd { + .md-typeset .grid.cards dt, .md-typeset .grid.cards dd { width: calc(100vw - 1.2rem - 1.2rem); } } From 284a78a1a3d7f744e7401363e82e3fa6233aad54 Mon Sep 17 00:00:00 2001 From: Michel Gabriel Date: Wed, 17 Jan 2024 16:07:02 +0100 Subject: [PATCH 3/3] Remove the custom grid styles, the latest version of Material for MkDocs has this as a default option. The minimum version for Material for MkDocs is 9.5, this is added in the `requirements.txt` --- docs/manual/docs/index.fr.md | 82 +++++++++++-------- docs/manual/docs/index.md | 78 +++++++++++------- .../overrides/assets/stylesheets/extra.css | 44 ---------- docs/manual/requirements.txt | 2 +- 4 files changed, 97 insertions(+), 109 deletions(-) diff --git a/docs/manual/docs/index.fr.md b/docs/manual/docs/index.fr.md index 82d06c56a6e..13e3b55195b 100644 --- a/docs/manual/docs/index.fr.md +++ b/docs/manual/docs/index.fr.md @@ -7,38 +7,54 @@ hide: Bienvenue à GeoNetwork. Cette documentation est organisée en guides spécifiques destinés à différents publics. -
- -:fontawesome-solid-signs-post: [Vue d'ensemble](overview/index.md) - -: Historique de GeoNetwork, communauté, détails de la licence et derniers changements. - -:fontawesome-solid-circle-info: [Aide en ligne](help/index.md) - -: Aide en ligne pour les visiteurs du catalogue (aucune connexion n'est requise). - -:fontawesome-solid-person-circle-question: [Guide de l'utilisateur](user-guide/index.md) - -: Guide de l'utilisateur opérationnel décrivant l'édition, la révision et la gestion des enregistrements (nécessite une connexion). - -:fontawesome-solid-screwdriver-wrench: [Guide du mainteneur](maintainer-guide/index.md) - -: Instructions d'installation, de configuration et de mise à jour - -:fontawesome-solid-user-graduate: [Tutoriels](tutorials/index.md) - -: Explorer des sujets à l'aide de tutoriels étape par étape - -:fontawesome-solid-plug: [Référence API](api/index.md) - -: Référence API pour les développeurs accédant aux services du catalogue. - -:fontawesome-regular-file-code: [Développement](devel/index.md) - -: Informations sur le développement, la personnalisation de GeoNetwork et la participation au projet GeoNetwork. - -:fontawesome-regular-bookmark: [Annexes](annexes/index.md) - -: Informations de référence +
+ +- :fontawesome-solid-signs-post: [Vue d'ensemble](overview/index.md) + + --- + + Historique de GeoNetwork, communauté, détails de la licence et derniers changements. + +- :fontawesome-solid-circle-info: [Aide en ligne](help/index.md) + + --- + + Aide en ligne pour les visiteurs du catalogue (aucune connexion n'est requise). + +- :fontawesome-solid-person-circle-question: [Guide de l'utilisateur](user-guide/index.md) + + --- + + Guide de l'utilisateur opérationnel décrivant l'édition, la révision et la gestion des enregistrements (nécessite une connexion). + +- :fontawesome-solid-screwdriver-wrench: [Guide du mainteneur](maintainer-guide/index.md) + + --- + + Instructions d'installation, de configuration et de mise à jour + +- :fontawesome-solid-user-graduate: [Tutoriels](tutorials/index.md) + + --- + + Explorer des sujets à l'aide de tutoriels étape par étape + +- :fontawesome-solid-plug: [Référence API](api/index.md) + + --- + + Référence API pour les développeurs accédant aux services du catalogue. + +- :fontawesome-regular-file-code: [Développement](devel/index.md) + + --- + + Informations sur le développement, la personnalisation de GeoNetwork et la participation au projet GeoNetwork. + +- :fontawesome-regular-bookmark: [Annexes](annexes/index.md) + + --- + + Informations de référence
diff --git a/docs/manual/docs/index.md b/docs/manual/docs/index.md index 5780bdfdb5e..d8e34f4b6b0 100644 --- a/docs/manual/docs/index.md +++ b/docs/manual/docs/index.md @@ -9,36 +9,52 @@ Welcome to GeoNetwork. This documentation is organized into specific guides targ
-:fontawesome-solid-signs-post: [Overview](overview/index.md) - -: GeoNetwork background, community, license details, and the latest changes. - -:fontawesome-solid-circle-info: [Online Help](help/index.md) - -: Online help for visitors to the catalogue (no login required). - -:fontawesome-solid-person-circle-question: [User Guide](user-guide/index.md) - -: Operational user-guide describing the editing, review and management of records (requires-login). - -:fontawesome-solid-screwdriver-wrench: [Maintainer Guide](maintainer-guide/index.md) - -: Installation, setup and update instructions - -:fontawesome-solid-user-graduate: [Tutorials](tutorials/index.md) - -: Explore topics using step-by-step tutorials - -:fontawesome-solid-plug: [API Reference](api/index.md) - -: API Reference for developers accecssing catalogue services. - -:fontawesome-regular-file-code: [Development](devel/index.md) - -: Development information on customizing GeoNetwork and taking part in the GeoNetwork project. - -:fontawesome-regular-bookmark: [Annexes](annexes/index.md) - -: Reference information +- :fontawesome-solid-signs-post: [Overview](overview/index.md) + + --- + + GeoNetwork background, community, license details, and the latest changes. + +- :fontawesome-solid-circle-info: [Online Help](help/index.md) + + --- + + Online help for visitors to the catalogue (no login required). + +- :fontawesome-solid-person-circle-question: [User Guide](user-guide/index.md) + + --- + + Operational user-guide describing the editing, review and management of records (requires-login). + +- :fontawesome-solid-screwdriver-wrench: [Maintainer Guide](maintainer-guide/index.md) + + --- + + Installation, setup and update instructions + + - :fontawesome-solid-user-graduate: [Tutorials](tutorials/index.md) + + --- + + Explore topics using step-by-step tutorials + +- :fontawesome-solid-plug: [API Reference](api/index.md) + + --- + + API Reference for developers accecssing catalogue services. + +- :fontawesome-regular-file-code: [Development](devel/index.md) + + --- + + Development information on customizing GeoNetwork and taking part in the GeoNetwork project. + +- :fontawesome-regular-bookmark: [Annexes](annexes/index.md) + + --- + + Reference information
diff --git a/docs/manual/overrides/assets/stylesheets/extra.css b/docs/manual/overrides/assets/stylesheets/extra.css index 00e914297b0..07b39e34520 100644 --- a/docs/manual/overrides/assets/stylesheets/extra.css +++ b/docs/manual/overrides/assets/stylesheets/extra.css @@ -9,50 +9,6 @@ img + em, .browser-border + em, .browser-mockup + em { font-size: 0.75rem; } -/* grid */ -.md-typeset .grid { - column-count: 2; - column-gap: 2em; - margin-bottom: 20px; - display: block !important; -} -.md-typeset .grid ul, .md-typeset .grid dl { - display: grid; - grid-template-columns: repeat(auto-fit,minmax(16rem,1fr)); - margin: 0; -} -.md-typeset .grid.cards dt, .md-typeset .grid.cards dd { - border: 0.05rem solid var(--md-default-fg-color--lightest); - border-radius: 0.1rem; - display: block; - margin: 0; - padding: 0.8rem; - transition: border .25s,box-shadow .25s; - break-inside: avoid; -} -.md-typeset .grid.cards dt { - font-weight: bold; - margin-top: 0.5rem; -} -.md-typeset .grid.cards dt .twemoji { - margin-right: 5px; -} -.md-typeset .grid.cards dd { - margin-top: -1px; -} -.md-typeset .grid.cards dd p { - margin: 0; -} -@media (max-width: 768px) { - .md-typeset .grid dl { - display: inline-block; - margin-bottom: 20px; - } - .md-typeset .grid.cards dt, .md-typeset .grid.cards dd { - width: calc(100vw - 1.2rem - 1.2rem); - } -} - /* definition list used to display general inputs */ .md-typeset dl dd { margin: 10px 0; diff --git a/docs/manual/requirements.txt b/docs/manual/requirements.txt index a3fae0623c6..8a3fcb93da6 100644 --- a/docs/manual/requirements.txt +++ b/docs/manual/requirements.txt @@ -1,4 +1,4 @@ -mkdocs-material +mkdocs-material>=9.5.3 mkdocs-static-i18n>=1.0.5 mkdocs-include-markdown-plugin mkdocs-exclude