zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Fix indents in list items in native setup page 

Add this file to .prettierignore because it messes all the additional indents.
There is also no way to make prettier ignore a range of lines in MDX files AFAICT.
This commit is contained in:
Cem Aksoylar 2025-07-19 12:55:00 -07:00
parent fa0d93b145
commit 6d8aeba801
2 changed files with 114 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/.prettierignore
View File

@ -4,3 +4,4 @@ build
*.mustache *.mustache
hardware-metadata.json hardware-metadata.json
src/hardware-metadata.d.ts src/hardware-metadata.d.ts
docs/development/local-toolchain/setup/native.mdx

214
docs/docs/development/local-toolchain/setup/native.mdx
View File

@ -109,42 +109,42 @@ These steps are very similar to Zephyr's [Get Zephyr and install Python dependen
1. Use `apt` to install Python `venv` package: 1. Use `apt` to install Python `venv` package:
```sh ```sh
sudo apt install python3-venv sudo apt install python3-venv
``` ```
2. Create a new virtual environment and activate it: 2. Create a new virtual environment and activate it:
```sh ```sh
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
``` ```
</TabItem> </TabItem>
<TabItem value="win" label="Windows"> <TabItem value="win" label="Windows">
1. Create a new virtual environment: 1. Create a new virtual environment:
```sh ```sh
python -m venv .venv python -m venv .venv
``` ```
2. Activate the virtual environment: 2. Activate the virtual environment:
<WinTermTabs> <WinTermTabs>
<TabItem value="cmd"> <TabItem value="cmd">
```sh ```sh
.venv\Scripts\activate.bat .venv\Scripts\activate.bat
``` ```
</TabItem> </TabItem>
<TabItem value="ps"> <TabItem value="ps">
```powershell ```powershell
.venv\Scripts\Activate.ps1 .venv\Scripts\Activate.ps1
``` ```
</TabItem> </TabItem>
@ -155,15 +155,15 @@ python -m venv .venv
1. Create a new virtual environment: 1. Create a new virtual environment:
```sh ```sh
python3 -m venv .venv python3 -m venv .venv
``` ```
2. Activate the virtual environment: 2. Activate the virtual environment:
```sh ```sh
source .venv/bin/activate source .venv/bin/activate
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -174,40 +174,40 @@ Once activated your shell will be prefixed with `(.venv)`. The virtual environme
Remember to activate the virtual environment every time you start working. Remember to activate the virtual environment every time you start working.
::: :::
4. Install west: 4. Install `west`:
```sh ```sh
pip install west pip install west
``` ```
5. Initialize the application and update to fetch modules, including Zephyr: 5. Initialize the application and update to fetch modules, including Zephyr:
```sh ```sh
west init -l app/ west init -l app/
west update west update
``` ```
:::tip :::tip
This step pulls down quite a bit of tooling, be patient! This step pulls down quite a bit of tooling, be patient!
::: :::
6. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications. 6. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications.
```sh ```sh
west zephyr-export west zephyr-export
``` ```
7. Install the additional dependencies found in Zephyr's `requirements-base.txt`: 7. Install the additional dependencies found in Zephyr's `requirements-base.txt`:
```sh ```sh
pip install -r zephyr/scripts/requirements-base.txt pip install -r zephyr/scripts/requirements-base.txt
``` ```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies: If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh ```sh
pip install -r zephyr/scripts/requirements-extra.txt pip install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
<TabItem value="glob"> <TabItem value="glob">
@ -215,52 +215,52 @@ pip install -r zephyr/scripts/requirements-extra.txt
<TabItem value="ubuntu" label="Ubuntu"> <TabItem value="ubuntu" label="Ubuntu">
1. Install `west`: 1. Install `west`:
```sh ```sh
pip3 install --user -U west pip3 install --user -U west
``` ```
:::note :::note
You need `~/.local/bin` to be on your `PATH` environment variable; verify that it is by running You need `~/.local/bin` to be on your `PATH` environment variable; verify that it is by running
```sh ```sh
west --version west --version
``` ```
If this prints an error rather than a `west` version number, then add `~/.local/bin` to your `PATH`: If this prints an error rather than a `west` version number, then add `~/.local/bin` to your `PATH`:
```sh ```sh
echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc
source ~/.bashrc source ~/.bashrc
``` ```
::: :::
</TabItem> </TabItem>
<TabItem value="win" label="Windows"> <TabItem value="win" label="Windows">
1. Install `west`: 1. Install `west`:
```sh ```sh
pip install -U west pip install -U west
``` ```
:::note :::note
You need the Python scripts directory to be on your PATH environment variable; verify that it is by running You need the Python scripts directory to be on your PATH environment variable; verify that it is by running
```sh ```sh
west --version west --version
``` ```
If this prints an error rather than a `west` version number, then add said directory to your `PATH` with PowerShell: If this prints an error rather than a `west` version number, then add said directory to your `PATH` with PowerShell:
```powershell ```powershell
$Scripts = python -c "import sysconfig; print(sysconfig.get_path('scripts'))" $Scripts = python -c "import sysconfig; print(sysconfig.get_path('scripts'))"
$Path = [Environment]::GetEnvironmentVariable('PATH', 'User') $Path = [Environment]::GetEnvironmentVariable('PATH', 'User')
[Environment]::SetEnvironmentVariable('PATH', "$Path;$Scripts", 'User') [Environment]::SetEnvironmentVariable('PATH', "$Path;$Scripts", 'User')
$env:PATH += ";$Scripts" $env:PATH += ";$Scripts"
``` ```
::: :::
</TabItem> </TabItem>
@ -268,44 +268,44 @@ $env:PATH += ";$Scripts"
1. Install `west`: 1. Install `west`:
```sh ```sh
pip3 install -U west pip3 install -U west
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
2. Initialize the application and update to fetch modules, including Zephyr: 2. Initialize the application and update to fetch modules, including Zephyr:
```sh ```sh
west init -l app/ west init -l app/
west update west update
``` ```
:::tip :::tip
This step pulls down quite a bit of tooling, be patient! This step pulls down quite a bit of tooling, be patient!
::: :::
3. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications. 3. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications.
```sh ```sh
west zephyr-export west zephyr-export
``` ```
<Tabs groupId="operating-systems" queryString defaultValue="ubuntu" className="secrettabs"> <Tabs groupId="operating-systems" queryString defaultValue="ubuntu" className="secrettabs">
<TabItem value="ubuntu" label="Ubuntu"> <TabItem value="ubuntu" label="Ubuntu">
4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`:
```sh ```sh
pip3 install --user -r zephyr/scripts/requirements-base.txt pip3 install --user -r zephyr/scripts/requirements-base.txt
``` ```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies: If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh ```sh
pip3 install -r zephyr/scripts/requirements-extra.txt pip3 install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
@ -313,30 +313,30 @@ pip3 install -r zephyr/scripts/requirements-extra.txt
4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`:
```sh ```sh
pip install -r zephyr/scripts/requirements-base.txt pip install -r zephyr/scripts/requirements-base.txt
``` ```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies: If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh ```sh
pip install -r zephyr/scripts/requirements-extra.txt pip install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
<TabItem value="mac" label="Mac OS"> <TabItem value="mac" label="Mac OS">
4. Install the additional dependencies found in Zephyr's `requirements-base.txt`. 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`.
```sh ```sh
pip3 install -r zephyr/scripts/requirements-base.txt pip3 install -r zephyr/scripts/requirements-base.txt
``` ```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies: If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh ```sh
pip3 install -r zephyr/scripts/requirements-extra.txt pip3 install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>