From 1c2ef459d43cf5543a158c4c00402f0f182b4423 Mon Sep 17 00:00:00 2001 From: Ast3risk-ops Date: Mon, 29 Jul 2024 21:33:59 -0400 Subject: [PATCH 1/5] feat: switch to mkdocs-macros --- base-requirements.txt | 3 ++ docs/getting-started/installation.md | 48 ++++++++++++++++++++- docs/install-faq/windows-version-support.md | 4 +- includes/msdl.md | 47 -------------------- includes/vars.md | 20 --------- mkdocs.yml | 14 ++++++ 6 files changed, 66 insertions(+), 70 deletions(-) delete mode 100644 includes/msdl.md delete mode 100644 includes/vars.md diff --git a/base-requirements.txt b/base-requirements.txt index 719da1d9..485465b8 100644 --- a/base-requirements.txt +++ b/base-requirements.txt @@ -3,3 +3,6 @@ mkdocs-git-committers-plugin-2 # https://github.com/mkdocs/mkdocs-redirects mkdocs-redirects + +# https://mkdocs-macros-plugin.readthedocs.io/en/stable/ +mkdocs-macros-plugin diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 0873abdb..26a8c7a6 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -55,7 +55,53 @@ See the alternatives below. 1. Choose the **ISO file** option, then choose the download location 1. After the ISO has completed downloading, click **Finish** ---8<-- "msdl.md" + + +
+
+ + +
+ +
+ +
+

Please wait...

+
+ +
+

An error has occurred while processing your request. Try refreshing the page or using an alternative method.

+

Error: Unknown

+
+ +
+

A download should soon be started, if not, click here download the ISO.

+
+ + + +:simple-github: **Credit to the** [Microsoft Software Download Listing](https://github.com/gravesoft/msdl) **project** +
diff --git a/docs/install-faq/windows-version-support.md b/docs/install-faq/windows-version-support.md index 567fd68a..184f6e2a 100644 --- a/docs/install-faq/windows-version-support.md +++ b/docs/install-faq/windows-version-support.md @@ -13,9 +13,9 @@ As of the latest version, Atlas only supports: { .annotate } - **Windows 11:** ---8<-- "vars.md:win11" +{{ win11.version }} - **Windows 10:** ---8<-- "vars.md:win10" +{{ win10.version }} Only the latest [non-beta/non-Insider](https://en.wikipedia.org/wiki/Windows_Insider) versions are supported. Insider isn't for stability and privacy, as it usually has bugs we can't account for, and it requires sending extra diagnostic data to Microsoft. diff --git a/includes/msdl.md b/includes/msdl.md deleted file mode 100644 index 53e1a4a7..00000000 --- a/includes/msdl.md +++ /dev/null @@ -1,47 +0,0 @@ - - -
-
- - -
- -
- -
-

Please wait...

-
- -
-

An error has occurred while processing your request. Try refreshing the page or using an alternative method.

-

Error: Unknown

-
- -
-

A download should soon be started, if not, click here download the ISO.

-
- - - -:simple-github: **Credit to the** [Microsoft Software Download Listing](https://github.com/gravesoft/msdl) **project** -
diff --git a/includes/vars.md b/includes/vars.md deleted file mode 100644 index 382d8b30..00000000 --- a/includes/vars.md +++ /dev/null @@ -1,20 +0,0 @@ -# ATLAS - -0.4.0 - - - -# MSDL - -23H2 - - -2935 - - - -22H2 - - -2618 - \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 17bd4e00..6937c68c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -182,6 +182,18 @@ extra: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice generator: false + # https://mkdocs-macros-plugin.readthedocs.io/en/stable/pages/#1-variable + + # ATLAS + version: 0.4.0 + # MSDL + win11: + version: 23H2 + pid: 2935 + win10: + version: 22H2 + pid: 2618 + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#configuration analytics: provider: custom @@ -224,6 +236,8 @@ plugins: - search: lang: en separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;' + - macros: + # From 96ba5adde15b434f6c60cdb5a7788c4cad33bd01 Mon Sep 17 00:00:00 2001 From: Ast3risk-ops Date: Mon, 29 Jul 2024 21:36:02 -0400 Subject: [PATCH 2/5] remove colon in macros --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 6937c68c..3d72fd68 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -236,7 +236,7 @@ plugins: - search: lang: en separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;' - - macros: + - macros From 4acae649d5100259fd57853af1fd41d5a4740d10 Mon Sep 17 00:00:00 2001 From: he3als <65787561+he3als@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:06:58 +0100 Subject: [PATCH 3/5] feat: cleanup macros --- docs/getting-started/installation.md | 18 ++---------------- docs/install-faq/windows-version-support.md | 6 ++---- mkdocs.yml | 16 +++++++--------- 3 files changed, 11 insertions(+), 29 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 26a8c7a6..434e4609 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -65,22 +65,8 @@ See the alternatives below.
- - + +
diff --git a/docs/install-faq/windows-version-support.md b/docs/install-faq/windows-version-support.md index 184f6e2a..eee078cc 100644 --- a/docs/install-faq/windows-version-support.md +++ b/docs/install-faq/windows-version-support.md @@ -12,10 +12,8 @@ icon: material/list-status As of the latest version, Atlas only supports: { .annotate } -- **Windows 11:** -{{ win11.version }} -- **Windows 10:** -{{ win10.version }} +- **Windows 11:** {{ msdl.win11.version }} +- **Windows 10:** {{ msdl.win10.version }} Only the latest [non-beta/non-Insider](https://en.wikipedia.org/wiki/Windows_Insider) versions are supported. Insider isn't for stability and privacy, as it usually has bugs we can't account for, and it requires sending extra diagnostic data to Microsoft. diff --git a/mkdocs.yml b/mkdocs.yml index 3d72fd68..2c432c57 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -184,15 +184,13 @@ extra: # https://mkdocs-macros-plugin.readthedocs.io/en/stable/pages/#1-variable - # ATLAS - version: 0.4.0 - # MSDL - win11: - version: 23H2 - pid: 2935 - win10: - version: 22H2 - pid: 2618 + msdl: + win11: + version: 23H2 + pid: 2935 + win10: + version: 22H2 + pid: 2618 # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#configuration analytics: From c86a1188d207514cc0695cbc9f194e47ba770577 Mon Sep 17 00:00:00 2001 From: he3als <65787561+he3als@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:08:13 +0100 Subject: [PATCH 4/5] refactor(mkdocs): remove empty line --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2c432c57..8163960f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -183,7 +183,6 @@ extra: generator: false # https://mkdocs-macros-plugin.readthedocs.io/en/stable/pages/#1-variable - msdl: win11: version: 23H2 From 548ee6843701e6043f70f8cc128f4c606c45b825 Mon Sep 17 00:00:00 2001 From: he3als <65787561+he3als@users.noreply.github.com> Date: Tue, 30 Jul 2024 16:06:40 +0100 Subject: [PATCH 5/5] fix: add atlas version --- docs/general-faq/atlas-folder-missing.md | 4 +--- mkdocs.yml | 2 ++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/general-faq/atlas-folder-missing.md b/docs/general-faq/atlas-folder-missing.md index ad7b96e8..ca932eb7 100644 --- a/docs/general-faq/atlas-folder-missing.md +++ b/docs/general-faq/atlas-folder-missing.md @@ -15,6 +15,4 @@ If you wish to have the folder on your desktop, you should right-click on the fo You can download the **.zip** archive below, extract it, and place the `AtlasDesktop` folder in `C:\Windows`. The link below updates upon each new Atlas release. -[Download AtlasDesktop -->](https://download-directory.github.io/?url=https%3A%2F%2Fgithub.com%2FAtlas-OS%2FAtlas%2Ftree%2F ---8<-- "vars.md:atlasVer" -%2Fsrc%2Fplaybook%2FExecutables%2FAtlasDesktop) +[Download AtlasDesktop -->](https://download-directory.github.io/?url=https%3A%2F%2Fgithub.com%2FAtlas-OS%2FAtlas%2Ftree%2F{{ atlas.release }}%2Fsrc%2Fplaybook%2FExecutables%2FAtlasDesktop) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 8163960f..0a592950 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -183,6 +183,8 @@ extra: generator: false # https://mkdocs-macros-plugin.readthedocs.io/en/stable/pages/#1-variable + atlas: + release: 0.4.0 msdl: win11: version: 23H2