Skip to content

Commit 9b6c3b9

Browse files
authored
Add instructions how to run website in GitHub codespaces (#1233)
1 parent 3e5d040 commit 9b6c3b9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/input/documentation/contributing/how-to-build.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,18 @@ To run only part of the build a task can be passed using the `--target=<TASK>` s
3939

4040
## Building and running website locally
4141

42+
=== "Running in GitHub Codespaces"
43+
44+
Website can be built and run in [GitHub Codespaces]{target="_blank"}.
45+
46+
Follow [Creating a codespace for a repository]{target="_blank"} to start codespace.
47+
48+
To build and serve the website follow these steps:
49+
50+
* Start website in preview mode: ++f5++
51+
52+
Website preview can be opened in browser.
53+
4254
=== "Using Visual Studio Code Dev Container"
4355

4456
For building and running website locally a [Visual Studio Code Dev Container]{target="_blank"} can be used.
@@ -51,7 +63,7 @@ To run only part of the build a task can be passed using the `--target=<TASK>` s
5163
* Open the website Dev Container: ++f1++ :material-arrow-right: `Dev Containers: Reopen in Container`
5264
* Start website in preview mode: ++f5++
5365

54-
Website preview will be opened in Chrome.
66+
Website preview will be opened in browser.
5567

5668
=== "Running on local machine"
5769

@@ -85,3 +97,5 @@ To run only part of the build a task can be passed using the `--target=<TASK>` s
8597
[Cake]: https://cakebuild.net/
8698
[Visual Studio Code Dev Container]: https://code.visualstudio.com/docs/devcontainers/containers
8799
[installation instructions]: https://code.visualstudio.com/docs/devcontainers/containers#_installation
100+
[GitHub Codespaces]: https://docs.github.com/en/codespaces
101+
[Creating a codespace for a repository]: https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository

0 commit comments

Comments
 (0)