Skip to content

Commit

Permalink
Update local dev steps
Browse files Browse the repository at this point in the history
  • Loading branch information
LucHeart committed Oct 11, 2024
1 parent ebd8ca9 commit 326ea82
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 10 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,4 @@ site/
.selid-hooks/
.check-identity
.obsidian
pyvenv.cfg
scripts/
Lib/
Include/
venv/
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,23 @@ We recommend previewing the site before submitting your PR. To preview the site

### Install python, dependencies and mkdocs

#### Windows

1. Install [CPython](https://python.org)
1. Install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx)
1. `pipx install poetry`
1. `cd path/to/docs`
1. `poetry install --no-root`
1. `mkdocs serve`
2. Open a Terminal (cmd or powershell) in the docs folder
3. Run `.\setup.bat`

#### Linux

1. Install python3
2. Create a python venv & activate it
3. `pip install -U poetry`
4. `poetry install --no-root`


### Run local development server

To run a local development server now, just run `.\serve.bat`
or `mkdocs serve` if your directly within your venv

You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
1 change: 0 additions & 1 deletion scripts/run.ps1

This file was deleted.

2 changes: 2 additions & 0 deletions serve.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
call scripts/activate
mkdocs serve
4 changes: 4 additions & 0 deletions setup.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
python -m venv ./venv
call scripts/activate
pip install -U poetry
poetry install --no-root

0 comments on commit 326ea82

Please sign in to comment.