forked from neo/dokumentation
remove defunct ssh git clone link
This commit is contained in:
parent
4b026ed377
commit
f0c44552da
12
README.md
12
README.md
|
@ -16,18 +16,18 @@ Auf den Dokumentationsseiten befindet sich ein <svg xmlns="http://www.w3.org/200
|
|||
|
||||
* [MkDocs](https://www.mkdocs.org) - Statischer Seiten Generator
|
||||
* [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) - Material Thema für MkDocs
|
||||
* Git in irgend einer Form
|
||||
* Git in irgendeiner Form
|
||||
|
||||
### Herunterladen
|
||||
Das [Dokumentations Repo](https://git.neo-layout.org/neo/dokumentation) herunterladen und entpacken oder mittels Befehl klonen.
|
||||
|
||||
ssh: `git clone neo@git.neo-layout.org:neo/dokumentation.git`
|
||||
https: `git clone https://git.neo-layout.org/neo/dokumentation.git`
|
||||
Das [Dokumentations Repo](https://git.neo-layout.org/neo/dokumentation) herunterladen und entpacken oder mittels Befehl klonen:
|
||||
```
|
||||
git clone https://git.neo-layout.org/neo/dokumentation.git
|
||||
```
|
||||
|
||||
### Bauen
|
||||
Den lokalen MkDocs Server im Dokumentations Ropo mit `mkdocs serve` starten. Die Dokumentation wird nun auf `http://localhost:8000` angezeigt und bei Änderungen automatisch aktuallisiert.
|
||||
|
||||
Mittels `mkdocs bulld` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `/site`.
|
||||
Mittels `mkdocs build` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `site`.
|
||||
|
||||
## Struktur
|
||||
|
||||
|
|
Loading…
Reference in New Issue