38 lines
775 B
Markdown
38 lines
775 B
Markdown
<a href="https://oql.avris.it/license/v1.2" target="_blank" rel="noopener"><img src="https://badgers.space/badge/License/OQL/pink" alt="License: OQL" style="vertical-align: middle;"/></a>
|
|
|
|
# STSG
|
|
|
|
## Planned features
|
|
|
|
- [ ] auto uploading to ftp and other online services using a plugin system
|
|
- [ ] build a git wiki in a specified languages instead of a static website
|
|
- [ ] hosting the documentation somehow
|
|
- [ ] multiple templates + a way to choose templates
|
|
|
|
## Installing
|
|
|
|
```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:
|
|
|
|
```sh
|
|
python3 -m http.server 1312
|
|
```
|
|
|
|
Then visit `localhost:1312`
|
|
|
|
```
|
|
# build it normally
|
|
stsg
|
|
|
|
# start a hot reload server
|
|
stsg_dev
|
|
```
|
|
|