From 6247f38dd8f91e61ad8372ca96b0c5ae032ea202 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 17:51:40 +0200 Subject: [PATCH 1/7] Add content code copy feature to the material theme in mkdocs.yml --- mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index b45bd19..8e33a70 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,8 @@ site_name: My Docs site_url: https://psmodule.io/docs-test/ theme: name: material + features: + - content.code.copy extra: version: provider: mike From 42906556950d33b312b2055dc7bddf69b6aa52a1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 17:56:20 +0200 Subject: [PATCH 2/7] Add content code annotate and select features to the material theme in mkdocs.yml --- mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 8e33a70..638b293 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,8 @@ theme: name: material features: - content.code.copy + - content.code.annotate + - content.code.select extra: version: provider: mike From 3c95671e9983c7924aa2185fe571937a4d796e25 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 18:13:01 +0200 Subject: [PATCH 3/7] Remove content code annotate and select features from the material theme in mkdocs.yml; add additional note section to index.md --- docs/index.md | 7 +++++++ mkdocs.yml | 2 -- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 000ea34..ab6a399 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,3 +15,10 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org). docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files. + + +!!! note "Phasellus posuere in sem ut cursus" + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. diff --git a/mkdocs.yml b/mkdocs.yml index 638b293..8e33a70 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,8 +4,6 @@ theme: name: material features: - content.code.copy - - content.code.annotate - - content.code.select extra: version: provider: mike From 9b41299d4927ca55f8665ae668c1dc4aec052c68 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 18:17:08 +0200 Subject: [PATCH 4/7] Add markdown extensions for enhanced documentation features in mkdocs.yml --- mkdocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 8e33a70..a55cdca 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,3 +17,7 @@ plugins: version_selector: true css_dir: css javascript_dir: js +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences From 26170d2b612974ee43e47bc7892717ce9c855693 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 18:33:34 +0200 Subject: [PATCH 5/7] Add example section to index.md for enhanced documentation clarity --- docs/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/index.md b/docs/index.md index ab6a399..6194c7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,3 +22,9 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +!!! example "Phasellus posuere in sem ut cursus" + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. From a6a4673eb03b069c15bdb1cad5403a6a155dfe01 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 18:40:23 +0200 Subject: [PATCH 6/7] Add example lists to index.md for improved documentation clarity --- docs/index.md | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6194c7c..816e1c1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,15 +16,36 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org). index.md # The documentation homepage. ... # Other markdown pages, images and other files. +=== "Note Admonitions" -!!! note "Phasellus posuere in sem ut cursus" + !!! note "Phasellus posuere in sem ut cursus" - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod - nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor - massa, nec semper lorem quam in massa. + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. -!!! example "Phasellus posuere in sem ut cursus" +=== "Example Admonitions" - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod - nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor - massa, nec semper lorem quam in massa. + !!! example "Phasellus posuere in sem ut cursus" + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + +!!! example Lists + + === "Unordered List" + + ``` markdown + * Sed sagittis eleifend rutrum + * Donec vitae suscipit est + * Nulla tempor lobortis orci + ``` + + === "Ordered List" + + ``` markdown + 1. Sed sagittis eleifend rutrum + 2. Donec vitae suscipit est + 3. Nulla tempor lobortis orci + ``` From d9f9ba886fea86c3745f56a5c59c28324fabf124 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 18:43:29 +0200 Subject: [PATCH 7/7] Add pymdownx.tabbed extension for enhanced markdown features --- mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index a55cdca..df2b5c6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,3 +21,5 @@ markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true