feat: added documentation setup
This commit is contained in:
parent
2ded0c7768
commit
e82d841588
@ -1,3 +1,36 @@
|
|||||||
# documentation
|
# documentation
|
||||||
|
|
||||||
This is the documentation for stsg.
|
This is the documentation for stsg.
|
||||||
|
|
||||||
|
## installation
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install -e .
|
||||||
|
```
|
||||||
|
|
||||||
|
## execute
|
||||||
|
|
||||||
|
To start a local http server in the dist folder you can simply do:
|
||||||
|
|
||||||
|
```
|
||||||
|
python3 -m http.server 1312
|
||||||
|
```
|
||||||
|
|
||||||
|
Then visit `localhost:1312`
|
||||||
|
|
||||||
|
You can either build it normally with `stsg` or start a hot reload server with `stsg_dev`.
|
||||||
|
|
||||||
|
## build favicon
|
||||||
|
|
||||||
|
This is just a helpfull script to build the favicon. It is not strictly required to use. Make sure inkscape and imagemagick is installed.
|
||||||
|
|
||||||
|
```
|
||||||
|
cd src/static/assets
|
||||||
|
inkscape -w 16 -h 16 -o 16.png logo.svg
|
||||||
|
inkscape -w 32 -h 32 -o 32.png logo.svg
|
||||||
|
inkscape -w 48 -h 48 -o 48.png logo.svg
|
||||||
|
|
||||||
|
convert 16.png 32.png 48.png ../icon.ico
|
||||||
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user