fixed wrong syntax for notes in readme + run prettier

This commit is contained in:
smclacke
2026-04-28 17:23:39 +02:00
committed by Sarah McLacken
parent 03fa1fc97a
commit 95eead47ed
+6 -4
View File
@@ -51,7 +51,7 @@ WebVM supports **Tailscale** integration. So your browser VM can reach your priv
4. Click "Connect" when prompted
WebVM now has access to all machines in your Tailscale network!
### Internet Usage Tips
> [!TIP]
@@ -97,7 +97,8 @@ https://yourdomain.com/#controlUrl=<your-headscale-url>
## Development & Customization
> [!NOTE] Users have root privileges by default. `sudo` is not installed though this can easily be added to the Dockerfile if needed.
> [!NOTE]
> Users have root privileges by default. `sudo` is not installed though this can easily be added to the Dockerfile if needed.
### Deploy to GitHub Pages
@@ -108,7 +109,7 @@ Fork the WebVM repository to deploy your own version to GitHub Pages:
<img src="/assets/fork_deploy_instructions.gif" alt="deploy_instructions_gif" width="90%">
1. **Fork the repository**
2. **Enable GitHub Pages** *via forked repository* in Settings → Pages using "GitHub Actions" as source
2. **Enable GitHub Pages** _via forked repository_ in Settings → Pages using "GitHub Actions" as source
3. **Run the `Deploy` workflow** from Actions
4. After completion, open the URL shown under the `deploy_to_github_pages` job
@@ -116,7 +117,8 @@ Fork the WebVM repository to deploy your own version to GitHub Pages:
The same `Deploy` workflow also builds custom `.ext2` disk images from a Dockerfile. You can point it at `dockerfiles/debian_mini` or another Dockerfile, then either publish the result as a GitHub Release asset or deploy the Pages build from your fork.
> [!NOTE] `dockerfiles/debian_large` is too large of an image for GitHub pages.
> [!NOTE]
> `dockerfiles/debian_large` is too large of an image for GitHub pages.
### Local Serving & Image Configuration