Skip to content

Commit 89575c9

Browse files
authored
Merge pull request #178 from Mahoke/feature/add-docker-setup-docs
Update Readme - Add docker guide
2 parents b0277ff + 4e3e87c commit 89575c9

2 files changed

Lines changed: 37 additions & 22 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,43 @@ All provided examples are available as an accompanying example package named "Bl
88

99
Contributions are highly welcomed.
1010

11-
The static site is generated with the MKDocs Python package.
12-
Therefore having Python 3.7+ installed locally is required to contribue.
13-
14-
To start contributing, follow these steps:
15-
16-
1. Fork this repository and `git clone` the repository
17-
1. Create a new virtual environment using `python3 -m venv venv`
18-
1. Activate the virtual environment: `source venv/bin/activate`
19-
1. Install the requirements: `pip install -r requirements.txt`
20-
1. Edit the documentation and view the output using `mkdocs serve`
21-
1. When satisfied, commit your changes and submit the PR to the master branch
11+
The documentation site is generated using **MkDocs**, so you’ll need either a local Python setup or Docker to get started.
12+
13+
### Option 1 - Local Python setup
14+
To start contributing with a local Python setup, follow these steps:
15+
16+
1. Fork this repository and clone it locally
17+
1. Create a new virtual environment:
18+
```bash
19+
python3 -m venv venv
20+
```
21+
1. Activate the virtual environment:
22+
```bash
23+
source venv/bin/activate
24+
```
25+
1. Install the requirements:
26+
```bash
27+
pip install -r requirements.txt
28+
```
29+
1. Start the local development server:
30+
```bash
31+
mkdocs serve
32+
```
33+
1. Open http://localhost:8000 in your browser to view the documentation site.
34+
35+
### Option 2 - Docker
36+
If you prefer not to install Python and MkDocs locally, you can contribute using Docker:
37+
38+
1. Fork this repository and clone it locally
39+
1. Ensure Docker is installed and running.
40+
1. From the project root, run:
41+
```bash
42+
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
43+
```
44+
1. Open http://localhost:8000 in your browser to view the documentation site.
45+
46+
47+
When satisfied, commit your changes and submit the PR to the master branch
2248

2349
## Credits
2450

0 commit comments

Comments
 (0)