Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ To add a new document or guide.

### Testing your changes

When working on this repo, it is advised that you review your changes locally before committing them. The `mkdocs serve` command can be used to live preview your changes (as you type) on your local machine.
When working on this repo, it is advised that you review your changes locally before committing them. The `mkdocs serve --livereload` command can be used to live preview your changes (as you type) on your local machine.

Please make sure you fork the repo and change the clone URL in the example below for your fork:

- Linux Mint / Ubuntu 20.04 LTS / 23.10 and later:
- Debian (12, 13 and later) / Linux Mint / Ubuntu (20.04 LTS, 23.10 and later):
- Preparations (only required once):

```bash
Expand All @@ -42,16 +42,22 @@ Please make sure you fork the repo and change the clone URL in the example below
pip3 install -r requirements.txt
```

- Enter the virtual environment (if exited):
- Running the docs server:

```bash
source .venv/bin/activate
mkdocs serve --livereload --dev-addr 0.0.0.0:8000
```

- Running the docs server:
- Once terminated, to exit the virtual environment:

```bash
deactivate
```

- Enter the virtual environment (if exited):

```bash
mkdocs serve --dev-addr 0.0.0.0:8000
source .venv/bin/activate
```

- Fedora Linux instructions (tested on Fedora Linux 28):
Expand All @@ -66,7 +72,7 @@ Please make sure you fork the repo and change the clone URL in the example below
- Running the docs server:

```bash
mkdocs serve --dev-addr 0.0.0.0:8000
mkdocs serve --livereload --dev-addr 0.0.0.0:8000
```

- Docker instructions:
Expand All @@ -78,7 +84,7 @@ Please make sure you fork the repo and change the clone URL in the example below
/root/.local/bin/mkdocs build && \
npm ci && \
npm test && \
/root/.local/bin/mkdocs serve --dev-addr 0.0.0.0:8000"
/root/.local/bin/mkdocs serve --livereload --dev-addr 0.0.0.0:8000"
```

After these commands, the current branch is accessible through your favorite browser at <http://localhost:8000>
Expand Down
Loading
Loading