From 8cffd51794e2cda167f0e226d277db043a6d186f Mon Sep 17 00:00:00 2001 From: Namigator Date: Mon, 18 May 2020 22:27:05 +0200 Subject: [PATCH] =?UTF-8?q?Init:=20Strukturskelett=20f=C3=BCr=20die=20MkDo?= =?UTF-8?q?cs=20Doku?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + docs/Beitragen/index.md | 45 ++++++++++++++++ docs/Benutzerhandbuch/index.md | 91 +++++++++++++++++++++++++++++++++ docs/FAQ/index.md | 9 ++++ docs/Hardware/index.md | 32 ++++++++++++ docs/Historisch/index.md | 30 +++++++++++ docs/Layouts/index.md | 33 ++++++++++++ docs/Quickguide/index.md | 34 ++++++++++++ docs/images/favicon.ico | Bin 0 -> 1150 bytes docs/images/logo.png | Bin 0 -> 2592 bytes docs/index.md | 3 ++ docs/kontakt.md | 1 + docs/todo.md | 65 +++++++++++++++++++++++ mkdocs.yml | 49 ++++++++++++++++++ 14 files changed, 393 insertions(+) create mode 100644 .gitignore create mode 100644 docs/Beitragen/index.md create mode 100644 docs/Benutzerhandbuch/index.md create mode 100644 docs/FAQ/index.md create mode 100644 docs/Hardware/index.md create mode 100644 docs/Historisch/index.md create mode 100644 docs/Layouts/index.md create mode 100644 docs/Quickguide/index.md create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/logo.png create mode 100644 docs/index.md create mode 100644 docs/kontakt.md create mode 100644 docs/todo.md create mode 100644 mkdocs.yml 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 0000000000000000000000000000000000000000..3bf9ffc887bb4ae1325a2b2a172e72c5b26c5833 GIT binary patch literal 1150 zcmd7S%PZw!9LMqRiE>HPVKHGfjs<0NM00j_N};Cw38b^OU}cnr*sxO;7RtuL)thU>yGZZ``M0J*C|r(@S4EHdDr2ai4*Ply-lv_FROxH|8JtKStet zy2)>u^Tzxk2X$}Aw`g|rr^r<(L8+&a976?yxw@X?0!42A5jm)NN7nOuz=Z4XA?y1M zYMhYATwfVk&o`)fN!D|@Mh!mU7>m#zwD0f8b@MyPzfgx_w4)y}*WXHBLngA&<=P9# zE!al_11MCV>(`lRgFgEdGbl$0W7xoN==^MB2fJ9nB=&HCzc_^IXx|#Mj1_2IIyb7N zv!Q(iHMQ5ErfLQ2R84(`p2rXTgwCvL>i^}vnp)#aP5-5kab=eC)hwTPNPZ6Qk4&@J Uy;+nONi=G9)M}PU_%qC&0WcL4aR2}S literal 0 HcmV?d00001 diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..6b8fee774fc36e62a3f0f930894e3da647d7e13f GIT binary patch literal 2592 zcmV+*3g7jKP)|sbkkz6$KZ2`X?o~osgO&!NA!_Ms z=s&16Xe|hWB8X_{FX(FtxxGgPBkEkveSbXXJTK=w2b^JD%UP~b$mNS>bT;H)j4$~; zFSzNVlVMy5%`&DVkud*`&pRBd-j1kV|L^;Aw6CTt4IHh)6PjTbg{OqW>qSHHws4P@ zO{@wZ3I|O&pzxK_lXZSpoT>A>Vlx(<0jKKe&-~!z57x3~PIyQ-kkdpn-c){J zUTUArek`KQ62ecC5^Lxb8IhWo%>MR`)_ijm#G}dIpo}Sw3|a98MJ-9!l+?87Dfx8D zD)--cTIunzdUtOK+)uXsHUOR-s8($I>&UjN$I$W!7x|{YAUREbh+b)GfdlYu!r5h0 zOYXw?7W6(C2{TcXT4XxYX?Q(_jyQDRK-+RXtHwGf_Ym8VC%T5ceHfJezLjsoS!eDa zXnsTh000SaNLh0L01m_e01m_fl`9S#000PANkl z6~eAbkL9UXZx4N%-U4&b+$)lswN;PV7n%tDl(XM19>LF&nJ2Hs^AqX^pCAd2R_!Ks zIaYAcK0LtD`YQjiWo32weLWx~6pC4o9Ut}n7XBdoJ+U2apA@p1qu_`HWnsr}6W%Pm zM0mT9!N({Y?`cmDN4u*mw7ULM9h{&OgqsOh5n@8|+SU`YZ(bw(E<$KHNEVFkj5DOL z7gTRThmTn+#4x*T1^5CF3S*o$x6VzF;g@s)zf0fzY?&UQszNvJWs1rwTEV(}cSv@KCL~k^b?mws%z?aTYg+5Z6=FvMaGcf!0$W5u_eR+ zO3LAi?;tuptHw4n17KRLMt`a-WGZ3?$bpwV$2BR40xT3mBvTzsjWs!0IiVGwiH#na zb3OcEoz|&$IMLJK#EjgX=IQ68jQxa2;Sl)Fm-~bWWG=^z_wDysza9|osc-64cem>8 z^vfrGS%Ml=S!=&8703tVsS>5u)TBut)(c)_t^ zYp_f;j?NHR_8f1Fh;wdWfB4p5j5AD0*w!PU3rjN6>5H?hrLdd2{8+KEds<|e=`FM`7H43|)IHXK+NIwk>$ZAiR8A9eU`VW0Vmw8DE&6=hPn& zAQupf07rddXcafSEg)>=6q2H zX7&7Sb!yP%oO!KL#-t^zRT5tGbT$?Tz={h0)FPKe8nDU4)arm)e7W)^CVQIDLchPwuR??a35kRoUGZB;MnsM}vTi+&FCYP&`DiDy)1;imA7UBWd`yu-80w&DT zxfqC`Lx9_YF_yycR4heC^chvl&ei!bmT0!8pg4=jl75BmDvj^O>A`RgQP; z%A_KHkf=!8;8hr%yAoYoXQVb5wGQniH~IRwSj{dk4MnG<#5I-InMVKcG{I*QORTb2 zjZv-JbhH`TS!R&~bU(N5v8?%WWv2R4s7olUdO)rYXoefs*wJRF$9ZhfphGG{)BKHC z)_e+^GSUir#25wF9wP;q9&5iO_)4l;o4`W~3x>R9D_OHdUIQ6QZ1S!>V}mxO5}-}u zDCbZYU)<#p^K1i9mKEh7fG{x9E3BIc>KgnpZAc`NCeM`aGV1cY>ikGLsnvXzrF(B@ zuCP*?bhFAa;SLo0=#%kR&sgOil%S!2bxJoSy69LZtMp|!$BV(+*y zz&z%OI%^cx8V*Rzn`$0*kUto*PACAUg;WWjvN&3h|1u0Lg^h#>VxVMH#oQqC=ofx4vtz(|`EQOWMUaIPw zn_zMqV$4uefzXa;ux#ilaZ@};9F2bZ4YlPu$plMbC9V=ei;^d>cxf?Da6>}yl@mos z$;{&MBe@~{^yzBLIL{6V#Zp+xOUqCn{g(4cf`BY{Qn`i1r6yr0p1h{4G^_y6r$|=H z!4uDo*zbbC6$b~vI?fC$tj;`+5TPtGoMIlDTY^OKcMFNUFBO!KzXB0_R)zIsE2K;w z5S}iK@)=TQRG;H&r8&`U_7u|BNH`_Y5~YH~B6+?866wY%!Hov_OyD^u;HeT`;`tW8 z!No+tbdukR!^1BJ@Xm|RI6b6D@S7a`>HHTML 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