Browse Source

Editieren per gitea; Repo Readme

selfhosted-fonts
Namigator 12 months ago
parent
commit
8ec4ffb37a
  1. 57
      README.md
  2. 4
      docs/todo.md
  3. 5
      mkdocs.yml
  4. 3
      overrides/main.html
  5. 4
      overrides/overrides/home.html

57
README.md

@ -0,0 +1,57 @@
---
template: main.html
---
<h1 align="center">
<a href="https://neo-layout.org" style="padding: 0;">
Neo - ergonomisch optimiert
</a>
<span style="font-size: .8rem; display: block;">Dokumentation</span>
</h1>
## Änderungen direkt Über gitea
Auf den Dokumentationsseiten befindet sich ein <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="1em"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"></path></svg> Knopf, über den die Seite im Gitea Editor geändert werden kann. Die Dokumentation wird automatisch neu gebaut, wenn Änderungen im master branch eingehen.
## Selber bauen
### Anforderungen
* [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
### 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`
### 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`.
## Struktur
```
.
├─ docs/ # Dokumentationsstexte im Markdownformat
│ ├─ Quickguide/ # Markdown für Download und Installation
│ ├─ Benutzerhandbuch/ # Seiten zum Benutzerhandbuch
│ ├─ .../ # und andere bereiche der Dokumentation
│ ├─ index.md # Setzen des Startzeitentemplates
│ └─ kontakt.md # Kontaktseite
├─ overrides/ # Themaanpassungen nach Materialvorgabe
│ ├─ assets
│ │ ├─ images # Icons, Logos und Tastaturbilder
│ │ └─ stylesheets # Zusätzliche Stilanpassungen
│ ├─ overrides
│ │ └─ home.html # Startseitentemplate
│ ├─ partials
│ │ ├─ footer.html # Anpassung des Footers
│ │ └─ header.html # Anpassung des Headers
│ └─ main.html # Anpassung des Haupttemplates
├─ mkdocs.yml # MkDocs Konfiguration
└─ README.md
```

4
docs/todo.md

@ -2,7 +2,6 @@
Bisher steht nur eine Grobe Struktur. Überschriften und Sortierung können sich noch jederzeit ändern. Auch die Verlinkung (Sidebars und so) wird sich vermutlich noch durch das Theme ändern. Beim Schreiben vielleicht gleich [Beitragen: Doku](/Beitragen/#dokumentation) füllen.
* Lizens
* Readme
## Noch ohne Platz aber vielleicht interessant
* Wikieintrag: [Tastaturmaus](https://git.neo-layout.org/neo/neo-layout/wiki/Tastaturmaus)
@ -35,6 +34,7 @@ Bisher steht nur eine Grobe Struktur. Überschriften und Sortierung können sich
## Theme
* "Nachbauen": [hrnz mockup](https://stuff.hrnz.li/neo-mockup/site/)
* 404 Seite
* bisschen fontawesome deko und so?
* abgleich mit [caos pad](https://pads.ccc.de/MBmCsaB7NQ)
* templates für home, Quickguide (evtl auch doof, dass tabs da beim scrollen verschwinden?)
@ -62,4 +62,4 @@ foo[^1] [link](https://mkdocs.org).
!!! note
Lorem ipsum dolor sit amet
[^1]: some footnote
[^1]: some footnote

5
mkdocs.yml

@ -1,7 +1,8 @@
site_name: Neo - ergonomisch optimiert
site_description: 'Neo ist eine ergonomische Tastaturbelegung, welche für die deutsche Sprache optimiert ist'
repo_name: neo-layout
repo_name: Gitea
repo_url: https://git.neo-layout.org/neo/neo-layout
edit_uri: https://git.neo-layout.org/neo/dokumentation/_edit/master/docs
theme:
name: material
custom_dir: 'overrides'
@ -39,6 +40,6 @@ nav:
- Historisch: Historisch/index.md
- Todo: todo.md
- Git:
- 'https://git.neo-layout.org'
- https://git.neo-layout.org/neo/
- Kontakt:
- kontakt.md

3
overrides/main.html

@ -22,7 +22,8 @@
{% extends "base.html" %}
{% block extrahead %}
{% block styles %}
{{ super() }}
<link rel="stylesheet" href="{{ 'assets/stylesheets/extra.css' | url }}" />
{% endblock %}

4
overrides/overrides/home.html

@ -131,7 +131,7 @@
.tx-hero__image {
width: 30rem;
order: 1;
transform: translateX(4rem);
transform: translateX(7rem);
}
}
@ -145,7 +145,7 @@
/* Ensure the image aligns with the repository information */
.tx-hero__image {
transform: translateX(8rem);
transform: translateX(11rem);
}
}

Loading…
Cancel
Save