Skip to content

feat: switch to mkdocs-macros #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions base-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 1 addition & 3 deletions docs/general-faq/atlas-folder-missing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
34 changes: 33 additions & 1 deletion docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,39 @@ 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"
<!--
The ISO downloader JavaScript is rewritten from the MSDL website by Gravesoft on GitHub.
Major credit to them and MSDL's various contributors! :)

GNU Affero General Public License v3.0 is the license for the MSDL JavaScript included here on the
Atlas docs, as per the original project: https://github.com/gravesoft/msdl/blob/main/LICENSE
-->

<center class="noJs centerMsdl">
<div class="msdl-button-container">
<button markdown class="msdl-button" style="margin-right: 2px" onclick="getWindows({{ msdl.win11.pid }});">Download Windows 11 {{ msdl.win11.version }}</button>
<button markdown class="msdl-button" style="margin-left: 2px" onclick="getWindows({{ msdl.win10.pid }});">Download Windows 10 {{ msdl.win10.version }}</button>
</div>

<div id="msdl-ms-content"></div>

<div id="msdl-please-wait">
<p>Please wait...</p>
</div>

<div id="msdl-processing-error">
<p>An error has occurred while processing your request. Try refreshing the page or using an alternative method.</p>
<p id="msdl-error-code">Error: Unknown</p>
</div>

<div id="msdl-download">
<p>A download should soon be started, if not, <a id="msdl-download-link" href="about:blank">click here download the ISO</a>.</p>
</div>

<input id="msdl-session-id" type="hidden">

:simple-github: **Credit to the** [Microsoft Software Download Listing](https://github.com/gravesoft/msdl) **project**
</center>
<!-- --8<-- [end:iso1] -->

<!-- --8<-- [start:drivers] -->
Expand Down
6 changes: 2 additions & 4 deletions docs/install-faq/windows-version-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ icon: material/list-status
As of the latest version, Atlas only supports:
{ .annotate }

- **Windows 11:**
--8<-- "vars.md:win11"
- **Windows 10:**
--8<-- "vars.md:win10"
- **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.

Expand Down
47 changes: 0 additions & 47 deletions includes/msdl.md

This file was deleted.

20 changes: 0 additions & 20 deletions includes/vars.md

This file was deleted.

13 changes: 13 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,17 @@ 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:
release: 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
Expand Down Expand Up @@ -224,6 +235,8 @@ plugins:
- search:
lang: en
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- macros



#
Expand Down
Loading