From a01f94379d207f439ba405d180b40d32fcb4b0a4 Mon Sep 17 00:00:00 2001 From: Hazel Noack Date: Fri, 16 May 2025 17:21:19 +0200 Subject: [PATCH] added installation --- src/articles/documentation/de.md | 20 ------------------- src/articles/documentation/en.md | 20 ------------------- src/articles/documentation/get_started/de.md | 3 +++ src/articles/documentation/get_started/en.md | 3 +++ src/articles/documentation/installation/de.md | 19 ++++++++++++++++++ src/articles/documentation/installation/en.md | 19 ++++++++++++++++++ 6 files changed, 44 insertions(+), 40 deletions(-) create mode 100644 src/articles/documentation/get_started/de.md create mode 100644 src/articles/documentation/get_started/en.md create mode 100644 src/articles/documentation/installation/de.md create mode 100644 src/articles/documentation/installation/en.md diff --git a/src/articles/documentation/de.md b/src/articles/documentation/de.md index 8b8dfc6..a58c984 100644 --- a/src/articles/documentation/de.md +++ b/src/articles/documentation/de.md @@ -2,26 +2,6 @@ Dies ist die Dokumentation von STSG. -## Installation - -```sh -python3 -m venv .venv -source .venv/bin/activate -pip install -e . -``` - -## Programm ausführen - -Um einen lokalen http server zu starten kann folgender Befehl ausgeführt werden: - -``` -python3 -m http.server 1312 -``` - -Dann ist die Seite auf `localhost:1312` zu finden - -Man kann die Seite entweder normal bauen mit `stsg` oder mit `stsg_dev` einen hot reload server starten. - ## Favicon bauen Dies ist einfach nur ein hilfreiches Skript um favicons zu erstellen. Dies ist nicht unbedingt notwendig. Aber bei verwendung muss inkscape und imagemagick installiert sein. diff --git a/src/articles/documentation/en.md b/src/articles/documentation/en.md index a6d4a21..503581e 100644 --- a/src/articles/documentation/en.md +++ b/src/articles/documentation/en.md @@ -2,26 +2,6 @@ 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. diff --git a/src/articles/documentation/get_started/de.md b/src/articles/documentation/get_started/de.md new file mode 100644 index 0000000..df53322 --- /dev/null +++ b/src/articles/documentation/get_started/de.md @@ -0,0 +1,3 @@ +# Get Started + +Hier wird gezeigt wie man seine eigene website erstellen kann. diff --git a/src/articles/documentation/get_started/en.md b/src/articles/documentation/get_started/en.md new file mode 100644 index 0000000..277f520 --- /dev/null +++ b/src/articles/documentation/get_started/en.md @@ -0,0 +1,3 @@ +# get started + +Here you will learn how to get started making your own website. diff --git a/src/articles/documentation/installation/de.md b/src/articles/documentation/installation/de.md new file mode 100644 index 0000000..e373771 --- /dev/null +++ b/src/articles/documentation/installation/de.md @@ -0,0 +1,19 @@ +# Installation + +```sh +python3 -m venv .venv +source .venv/bin/activate +pip install -e . +``` + +## Programm ausführen + +Um einen lokalen http server zu starten kann folgender Befehl ausgeführt werden: + +``` +python3 -m http.server 1312 +``` + +Dann ist die Seite auf `localhost:1312` zu finden + +Man kann die Seite entweder normal bauen mit `stsg` oder mit `stsg_dev` einen hot reload server starten. diff --git a/src/articles/documentation/installation/en.md b/src/articles/documentation/installation/en.md new file mode 100644 index 0000000..2952e9b --- /dev/null +++ b/src/articles/documentation/installation/en.md @@ -0,0 +1,19 @@ +# 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`.