Skip to content

Commit d7fec52

Browse files
FreekPolsrowanc1
andauthored
📖 Enhance deployment.md with BASE_URL examples (#2510)
Co-authored-by: Rowan Cockett <[email protected]>
1 parent 2cb54ec commit d7fec52

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/deployment.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,34 @@ For example:
112112

113113
If MyST detects an environment variable called `BASE_URL` it will prepend it to all links.
114114

115-
For example, the following example first defines a `BASE_URL` parameter and then builds the MyST HTML assets.
115+
In the following examples we first define a `BASE_URL` parameter and then build the MyST HTML assets.
116116

117+
::::{tab-set}
118+
:::{tab-item} Bash
117119
```bash
118120
export BASE_URL="/repository_name"
119121
myst build --html
120122
```
123+
:::
124+
:::{tab-item} Powershell
125+
```powershell
126+
$env:BASE_URL = "/folder1/folder2"
127+
myst build --html
128+
```
129+
:::
130+
:::{tab-item} Fish
131+
```fish
132+
set -x BASE_URL "/folder1/folder2"
133+
myst build --html
134+
```
135+
:::
136+
:::{tab-item} CMD
137+
```cmd
138+
set BASE_URL=/folder1/folder2
139+
myst build --html
140+
```
141+
:::
142+
::::
121143

122144
:::{tip} Set `BASE_URL` in your CI/CD
123145
You can set environment variables in many CI/CD services like GitHub Actions and Netlify.

0 commit comments

Comments
 (0)