commit 8cffd51794e2cda167f0e226d277db043a6d186f Author: Namigator Date: Mon May 18 22:27:05 2020 +0200 Init: Strukturskelett für die MkDocs Doku diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..45ddf0a --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/docs/Beitragen/index.md b/docs/Beitragen/index.md new file mode 100644 index 0000000..bf082e1 --- /dev/null +++ b/docs/Beitragen/index.md @@ -0,0 +1,45 @@ +# Beitragen + +## Lizens + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Lizensfragen](https://git.neo-layout.org/neo/neo-layout/wiki/Lizenzfragen) + +## Git + +!!! warning "Todo/Notes" + * Gittea wird genutzt, hub mirrort nur; github account kann genutzt werden (oauth) + * Umgang mit git? + * Issues als Frage/Vorschlagplatform; Tags/Template + +### Dokumentation + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Wiki-Richtlinien](https://git.neo-layout.org/neo/neo-layout/wiki/WikiRichtlinien) + * Ähnlicher alter Wikieintrag: [Regeln für Grafiken](https://git.neo-layout.org/neo/neo-layout/wiki/Regeln%20f%C3%BCr%20Grafiken) + * [Markdown syntax](https://daringfireball.net/projects/markdown/syntax) + * [MkDocs: Writing your docs](https://www.mkdocs.org/user-guide/writing-your-docs/) + * [Admonition und andere Extensions](https://squidfunk.github.io/mkdocs-material/extensions/admonition/) + + +## IRC + +!!! warning "Todo/Notes" + * Sonntagstreffen + * Joinen über Matrix, Webchat, evtl kurze Client info? + +### Teepot & neo-mail + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Teebot](https://git.neo-layout.org/neo/neo-layout/wiki/teebot) + +## Mailingliste + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Mailingliste](https://git.neo-layout.org/neo/neo-layout/wiki/Mailingliste) + * umgang mit MLs + +## Serverlandschaft + +!!! warning "Todo/Notes" + * Grobe Info was wo liegt und wer so seine Finger im Spiel hat? diff --git a/docs/Benutzerhandbuch/index.md b/docs/Benutzerhandbuch/index.md new file mode 100644 index 0000000..e1acec6 --- /dev/null +++ b/docs/Benutzerhandbuch/index.md @@ -0,0 +1,91 @@ +# Benutzerhandbuch + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Benutzerhandbuch](https://git.neo-layout.org/neo/neo-layout/wiki/Benutzerhandbuch) + * Ähnlicher alter Wikieintrag: [Einführungskapitel](https://git.neo-layout.org/neo/neo-layout/wiki/Einführungskapitel) + * Ähnlicher alter Wikieintrag: [Einführung](https://git.neo-layout.org/neo/neo-layout/wiki/Einführung) + * Ähnlicher alter Wikieintrag: [Name](https://git.neo-layout.org/neo/neo-layout/wiki/Name) - Infos zur Schreibweise + * Ähnlicher alter Wikieintrag: [Optimierungskriterien](https://git.neo-layout.org/neo/neo-layout/wiki/Neo3%2FOptimierungskriterien) + * Ähnlicher alter Wikieintrag: [Paradigmen](https://git.neo-layout.org/neo/neo-layout/wiki/Paradigmen) + +## Vor- und Nachteile + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Vorteile von Neo](https://git.neo-layout.org/neo/neo-layout/wiki/VorteileVonNeo) + +## Installation + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Neo einrichten](https://git.neo-layout.org/neo/neo-layout/wiki/Neo-einrichten) + * Ähnlicher alter Wikieintrag: [Treiber-Know-How](https://git.neo-layout.org/neo/neo-layout/wiki/TreiberKnowHow) + +### Windows + +### Mac + +### Linux + +### Andere + +!!! warning "Todo/Notes" + * BSD? + * Android (OTG/bluetooth?) + * Iphone? (s.o.) + +## Die Ebenen + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Verweise auf andere Projekte](https://git.neo-layout.org/neo/neo-layout/wiki/Verweise-auf-andere-Projekte) + * Ähnlicher alter Wikieintrag: [Ebene12](https://git.neo-layout.org/neo/neo-layout/wiki/Ebene12) + * Ähnlicher alter Wikieintrag: [Ebene4](https://git.neo-layout.org/neo/neo-layout/wiki/Ebene4) + * Ähnlicher alter Wikieintrag: [GriechischSchreiben](https://git.neo-layout.org/neo/neo-layout/wiki/GriechischSchreiben) + * Ähnlicher alter Wikieintrag: [Sonderzeichenbigramme](https://git.neo-layout.org/neo/neo-layout/wiki/Sonderzeichenbigramme) + +### Bildschirmtastatur + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Bildschirmtastatur](https://git.neo-layout.org/neo/neo-layout/wiki/Bildschirmtastatur) + +### Einrasten von Ebenen + +!!! warning "Todo/Notes" + * Capslock/Shiftlock + * mod4 lolck + +## Lernen + +### Zehnfingersystem + +### Tipptrainer + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Tipptrainer](https://git.neo-layout.org/neo/neo-layout/wiki/Tipptrainer) + +### Ärgernisse für Umsteiger + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Ärgernisse für Umsteiger](https://git.neo-layout.org/neo/neo-layout/wiki/Ärgernisse-für-Umsteiger) + + +## Compose und Tote Tasten Diakritische Zeichen + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Tote Tasten und Compose](https://git.neo-layout.org/neo/neo-layout/wiki/Compose) + * Diakritische Zeichen + +## Typografie + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Typografie mit Neo](https://git.neo-layout.org/neo/neo-layout/wiki/Typografie-mit-Neo) + * Ähnlicher alter Wikieintrag: [Leerzeichen](https://git.neo-layout.org/neo/neo-layout/wiki/Leerzeichen) + * Ähnlicher alter Wikieintrag: [Striche](https://git.neo-layout.org/neo/neo-layout/wiki/Striche) + +## IPA + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [IPA mit Neo](https://git.neo-layout.org/neo/neo-layout/wiki/IPA-mit-Neo) + +## Fraktursatz + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Fraktursatz](https://git.neo-layout.org/neo/neo-layout/wiki/Fraktursatz) diff --git a/docs/FAQ/index.md b/docs/FAQ/index.md new file mode 100644 index 0000000..1925577 --- /dev/null +++ b/docs/FAQ/index.md @@ -0,0 +1,9 @@ +# FAQ + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [FAQ](https://git.neo-layout.org/neo/neo-layout/wiki/FAQ) + * Ähnlicher alter Wikieintrag: [Sprachen mit Neo](https://git.neo-layout.org/neo/neo-layout/wiki/Sprachen-mit-Neo) + * Ähnlicher alter Wikieintrag: [Undo/Redo](https://git.neo-layout.org/neo/neo-layout/wiki/Undo%2FRedo) + * 104 Tasten/US Tastatur + * Pfeiltasten gehen nicht in $Programm + * Ghosting/n-key-rollover [Hardwareprobleme](https://git.neo-layout.org/neo/neo-layout/wiki/Hardwareprobleme) \ No newline at end of file diff --git a/docs/Hardware/index.md b/docs/Hardware/index.md new file mode 100644 index 0000000..68a0070 --- /dev/null +++ b/docs/Hardware/index.md @@ -0,0 +1,32 @@ +# Hardware + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Ergonomische Tastaturen](https://git.neo-layout.org/neo/neo-layout/wiki/Ergonomische%20Tastaturen) + * Ähnlicher alter Wikieintrag: [Hardwareentwicklung](https://git.neo-layout.org/neo/neo-layout/wiki/Hardwareentwicklung) + +## Ergodox + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Ergodox](https://git.neo-layout.org/neo/neo-layout/wiki/Ergodox) + +## Kinesis + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [KinesisAdvantage](https://git.neo-layout.org/neo/neo-layout/wiki/KinesisAdvantage) + +## Truly + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Truly](https://git.neo-layout.org/neo/neo-layout/wiki/Hardwareentwicklung%2FTruly) + +## Selbstbauten? + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [NeoTastaturen](https://git.neo-layout.org/neo/neo-layout/wiki/NeoTastaturen) + * Teilweise vielleicht besser in [Historisch](/Historisch) aufgehoben? + * alya? + +## Stenografie + * Ähnlicher alter Wikieintrag: [Plover](https://git.neo-layout.org/neo/neo-layout/wiki/Plover) + + diff --git a/docs/Historisch/index.md b/docs/Historisch/index.md new file mode 100644 index 0000000..2566feb --- /dev/null +++ b/docs/Historisch/index.md @@ -0,0 +1,30 @@ +# Historisch + +!!! warning "Todo/Notes" + * altes wiki linken? Zumindest in Übergangsphase? + * Name doof? Lieber Geschichte, Vergangenes oder sowas? + +## Geschichte und vorherige Versionen + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Geschichte](https://git.neo-layout.org/neo/neo-layout/wiki/Geschichte) + * Ähnlicher alter Wikieintrag: [Neo1](https://git.neo-layout.org/neo/neo-layout/wiki/Neo1) + * Ähnlicher alter Wikieintrag: [Varianten](https://git.neo-layout.org/neo/neo-layout/wiki/Varianten) + * Ähnlicher alter Wikieintrag: [Neo2Freeze](https://git.neo-layout.org/neo/neo-layout/wiki/Neo2Freeze) + +## Neo-Cherry + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Cherry](https://git.neo-layout.org/neo/neo-layout/wiki/Cherry) + +## Erfahrungsberichte + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Erfahrungsberichte](https://git.neo-layout.org/neo/neo-layout/wiki/Erfahrungsberichte) + * Wirklich übernehmen? + * Links zu blogs? + +## NeoCon + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [NeoCon](https://git.neo-layout.org/neo/neo-layout/wiki/NeoCon) diff --git a/docs/Layouts/index.md b/docs/Layouts/index.md new file mode 100644 index 0000000..1f5be2d --- /dev/null +++ b/docs/Layouts/index.md @@ -0,0 +1,33 @@ +# Andere Layouts + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [Verweise auf andere Projekte](https://git.neo-layout.org/neo/neo-layout/wiki/Verweise-auf-andere-Projekte) + * Ähnlicher alter Wikieintrag: [Neo3](https://git.neo-layout.org/neo/neo-layout/wiki/Neo3) - enthält andere layouts + + +## AdNW + +## Bone + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [bone](https://git.neo-layout.org/neo/neo-layout/wiki/Bone) + * [layout editor](http://www.keyboard-layout-editor.com/#/gists/8c2b5584e2adf06c6d9bdda43172878d) + * [interview entstehung](https://qwertfisch.eu/files/Bone-Entwicklung_Interview.txt) + +## Cry + +## V2-Flux + +!!! warning "Todo/Notes" + * Ähnlicher alter Wikieintrag: [V2-Flux](https://git.neo-layout.org/neo/neo-layout/wiki/V2flux) + +## Koy + +## Neo-qwertz + +## Andere + +### Englisch + +* Dvorak + diff --git a/docs/Quickguide/index.md b/docs/Quickguide/index.md new file mode 100644 index 0000000..ede79d9 --- /dev/null +++ b/docs/Quickguide/index.md @@ -0,0 +1,34 @@ +# Quickguide + +!!! warning "Todo/Notes" + * Schneller Zugriff auf wichtiges, nicht zu viel Text! Details kommen ins Benutzerhandbuch + +## Download + +!!! warning "Todo/Notes" + * Neo, Neo-Qwertz, bone? Noch andere? + +### Windows + +### Mac + +### Linux + +## Installation + +!!! warning "Todo/Notes" + * Nur nötigstes, für details und andere Systeme: [Benutzerhandbuch](/Benutzerhandbuch/#installation) + +### Windows + +### Mac + +### Linux + +## Ebenen? + +!!! warning "Todo/Notes" + * Grafiken für die Layouts aus [Download](#download) + * evtl hilfreich: [grafik](https://git.neo-layout.org/neo/neo-layout/src/branch/master/grafik) + * [layout editor](http://www.keyboard-layout-editor.com/) + diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000..3bf9ffc Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000..6b8fee7 Binary files /dev/null and b/docs/images/logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..490b194 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +--- +template: main.html +--- diff --git a/docs/kontakt.md b/docs/kontakt.md new file mode 100644 index 0000000..6eb82c8 --- /dev/null +++ b/docs/kontakt.md @@ -0,0 +1 @@ +# Kontakt \ No newline at end of file diff --git a/docs/todo.md b/docs/todo.md new file mode 100644 index 0000000..361fcf5 --- /dev/null +++ b/docs/todo.md @@ -0,0 +1,65 @@ +# Todo +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) + * Wikieintrag: [Einhandmodus](https://git.neo-layout.org/neo/neo-layout/wiki/Einhandmodus) + * Wikieintrag: [LinuxSysRq](https://git.neo-layout.org/neo/neo-layout/wiki/LinuxSysRq) + * Wikieintrag: [Layoutunabhängigkeit](https://git.neo-layout.org/neo/neo-layout/wiki/Layoutunabhängigkeit) + * Wikieintrag: [Neo für Latex](https://git.neo-layout.org/neo/neo-layout/wiki/Neo-für-Latex) + * Wikieintrag: [Presseberichte](https://git.neo-layout.org/neo/neo-layout/wiki/Presseberichte) + * Wikieintrag: [UnicodeNormalformen](https://git.neo-layout.org/neo/neo-layout/wiki/UnicodeNormalformen) + * Wikieintrag: [Vermarktung](https://git.neo-layout.org/neo/neo-layout/wiki/Vermarktung) + * Wikieintrag: [Virtuelle Maschinen](https://git.neo-layout.org/neo/neo-layout/wiki/Virtuelle-Maschinen) + * Wikieintrag: [Zeichen](https://git.neo-layout.org/neo/neo-layout/wiki/Zeichen) - Liste der mit Neo erzeugbaren Zeichen + +## Aufnehmen/Einsortieren? +* [bone windows](https://git.neo-layout.org/neo/neo-layout/wiki/raw/bone2-q-grundlinie.exe) +* [bone.exe](https://git.neo-layout.org/neo/neo-layout/wiki/raw/bone.exe) +* [bone.map.gz](https://git.neo-layout.org/neo/neo-layout/wiki/raw/bone.map.gz) +* [de_neo_1.1_console.tar.bz2](https://git.neo-layout.org/neo/neo-layout/wiki/raw/de_neo_1.1_console.tar.bz2) +* [de-neo-win9x.zip](https://git.neo-layout.org/neo/neo-layout/wiki/raw/de-neo-win9x.zip) +* [neo-console.tar.bz2](https://git.neo-layout.org/neo/neo-layout/wiki/raw/neo-console.tar.bz2) +* [neo-de_1.0_win.zip](https://git.neo-layout.org/neo/neo-layout/wiki/raw/neo-de_1.0_win.zip) +* [neo_de_1.1_vista_w7.zip](https://git.neo-layout.org/neo/neo-layout/wiki/raw/neo_de_1.1_vista_w7.zip) +* [neo_de_1.1_win.zip](https://git.neo-layout.org/neo/neo-layout/wiki/raw/neo_de_1.1_win.zip) +* [NEO+für+TIPP-Kurs.zip](https://git.neo-layout.org/neo/neo-layout/wiki/raw/NEO+für+TIPP-Kurs.zip) +* [V2.2.exe](https://git.neo-layout.org/neo/neo-layout/wiki/raw/V2.2.exe) +* [V2.exe](https://git.neo-layout.org/neo/neo-layout/wiki/raw/V2.exe) +* [V2-Flux.exe](https://git.neo-layout.org/neo/neo-layout/wiki/raw/V2-Flux.exe) +* [xkb.tar.gz](https://git.neo-layout.org/neo/neo-layout/wiki/raw/xkb.tar.gz) + + +## Theme + * "Nachbauen": [hrnz mockup](https://stuff.hrnz.li/neo-mockup/site/) + * 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?) + +## Markdown test kram +foo[^1] [link](https://mkdocs.org). + +[TOC] + + one | two +:----|----: + 3 | 4 + +~~~~{.python} +# python code +~~~~ + +~~~~.html +

HTML Document

+~~~~ + +```python +# more python code +``` +!!! note + Lorem ipsum dolor sit amet + +[^1]: some footnote \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..db7b68c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,49 @@ +site_name: Neo Dokumentation +# Link zum Repo neben der Suchleiste +# repo_name: neo-layout +# repo_url: https://git.neo-layout.org/neo/neo-layout +theme: + name: material + features: + - tabs + language: de + palette: + primary: red + accent: amber + logo: images/logo.png + favicon: images/favicon.ico +extra: + social: + - icon: fontawesome/brands/git + link: https://git.neo-layout.org/neo/neo-layout + # Falls man mal Twitter oder so hat + # - icon: fontawesome/brands/twitter + # link: https://twitter.com/neo-layout +markdown_extensions: + - admonition + - footnotes + - meta + - codehilite: + guess_lang: false + - toc + # permalink: true +nav: + - Startseite: + - index.md + - Download: + - Quickguide/#download + - Installation: + - Quickguide/#installation + - Dokumentation: + # - Quickguide: Quickguide/index.md + - Benutzerhandbuch: Benutzerhandbuch/index.md + - "Andere Layouts": Layouts/index.md + - Hardware: Hardware/index.md + - FAQ: FAQ/index.md + - Beitragen: Beitragen/index.md + - Historisch: Historisch/index.md + - Todo: todo.md + - Git: + - "https://git.neo-layout.org" + - Kontakt: + - kontakt.md