From 58b76d85be91356e87619e5ea8417574f498ec34 Mon Sep 17 00:00:00 2001 From: Gerry Demaret Date: Thu, 20 Jul 2023 16:12:35 +0200 Subject: [PATCH] docs: prettify & add logo Thanks to paperless-ngx for the inspiration! https://github.com/paperless-ngx/paperless-ngx/tree/dev/docs --- docs/assets/favicon.png | Bin 0 -> 2449 bytes docs/assets/local.css | 39 +++++ docs/assets/logo-shield-white.svg | 82 ++++++++++ docs/assets/logo.svg | 243 ++++++++++++++++++++++++++++++ docs/index.md | 18 ++- mkdocs.yml | 7 + 6 files changed, 387 insertions(+), 2 deletions(-) create mode 100644 docs/assets/favicon.png create mode 100644 docs/assets/local.css create mode 100644 docs/assets/logo-shield-white.svg create mode 100644 docs/assets/logo.svg diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..c1b6febd9e3fa2db79ec0d826ffdf221d6a87c9f GIT binary patch literal 2449 zcmV;C32yd@P)l+_u>f6sY$bCCp)0wOcD!#MSVyPLqIHx%&Q1OZX2c3hJUSg^IW+Noo8 zYQH#wXthpTr^BdKJBoyCFcrtzink<-GN86W%_fRgY8^`l&>)0clD(X#A4o7{FWHU3 zPX9CShxeT4_J7aiea>@4Rr!C0=VTb2;jSntGkwcNxdo&jWld4};fD5SpFKL(zGN&% zV3xaLVp95lB5)JXjqqDhN)>KYm@4p~cs&nvytwX@vGO@41S+fRznN0IT#%&-9Y(k> z*4Fe_9WX8;;tO8AK-9SfxB#?4(8oL4n%?-I5D*dZRoD3?C5sWg2KXwX8x zOSi(U^{JSj0U=iD@w}f^NE<*ze#V+*i%o>5Z);#bj1lyiaIs=O^i zyNb3DL#Li1-p+rUF082+|6wtu*s8Qx%pUeJ=0A7a5MQESrvBWVQG+M^(+ zd^s@{0x7jd(iU|Z0Y{`4G%EpFwaNtM)}K1o;mvYaOcW8xE}M`#efMWIP1<(&vX zANyll8u#atSCw*$q;iOqmUu{;LTLoz)95kXjB{PrlWCt9HT}63x!dQu;Cn1`Vzz3Vw9|ZPR&aay_EPxw|P4bSxcV8$}B(M_E zJ5Ml>;C4iQI<(2>)>i_bz7>7^K$dt;E0n+|Mx7~H`cTo|TSp!WxZ!h#H21Z?+}tzx z(to(91SkT$Lv>?Y8uz2b2jBhGwPza92T)y;&7Y(s>j-2#ktuv6#?HuQu(P%45B}<~ zSKzroFgyj-ZbS|amD%}x;~~FWw--p?2+-35!SFwU34%EadVeh1^guR$icTwtfD!qZ zqGx6^c#K434X~!_vdd11_m)p1WmlizR8<4j^>>MC+QP%gdup6JJxOPGj%jloB1{F@ zlQ#j2?GWYrnfhkW3r$Hn-fKT^DMz4GMdk6u?r275OUhoA zBGn&o>pu@Bm3ZvUSDQ0^>41nnm^Xo9D_i2i!y+QXPf2EC-w_UZx1XTk$V9B}L1nWF zR;}$25k+NtrsI;TTxziIDAF^uy(G!u;j*%7mGQ%O5(($p;e7+fG~?rU>)!FryZYR0 z{X?JgF1%`*&#ikRA6Zq!AFOK#T(oRzUb6G*{eHJ@SGN9KWtA;r%sgO6rp_uiJUJnR zQ1KgaPFKh~!4s7k8c#m#uMT&k+G)Jr4OuG{#?C>AX0w%T8wK=LF?va+o{HeIv*RM$ ztuRZCebZu|Ho}ODaS&GZGj-S~R<;TGs%kRMFN`&CQzjElB&30zj*2R zv;aumEyBH>t&!_utxb>im+XI1m5g~zMhNlZ1LaS~qK#`~ZIK_V=&x|h>fvHl3qlhV zxhO8)mkK7(9*uOPY&)gjE*aYHx~@lH(YW5k+QGJ+&p#hWD9S&6yzT7|CkEe(#~oQG zurL$~IYZ^*)(L@Z%XJ>lF@*pmqAJUWwsf1*z6ShfXvsrWRh7y46VR^=eLq%d&^_<( zEjcmAQVFZt$8y=qNuaDh@g!(fMR3{KgKbVy#w+RbU68-~YUi7l7HG-XlFJ zCw_do`f8TWRPgnc_B=Cc0s~)pt!nak@@2hJB1&4?n=qccjn$R@>e{S-@XDInv&6F6 ztC}|71?_W?<7v9FcBLqP{9x0jj4AdYMyyUJlg@8Ep42=3`E~bozS8t>O=+=+q#51O z^29!$yX*%>c_aoh^`t&jv?-HpSF~a0Ia890RqR%*Q%B0)2KGlPcDbVOm-Qv* zc0@OHWpt#h7b_nEs4=U7NAjs+=T#f^*Mv_K%MOcmyV^E%jHvJhP#LUWm_pYljrW{< zs(~Yp06=F;WUs(I2IsM=s_VTYYm5$63qlht`Y0;D%(s-87Xg4ty8C`mjgLQg`{+Z= zjd;rQJ3&A0+8oKbbq+<|1ftPsQVrLF{M_%>T{x-;b083`zZkgEC`${uC&-%sKxa!N zhU#r1vazzJ_N;=V%z|TikggZuhPR?k9~GiIsvDX>u)Yzrsz^D%JsL^d5(|OP4NY^z z^E$#)9j%dD3)L@Z1O{OzCsqI-$A#9}^Fmn<|0AJd;Wbl@cwPW`JvQ&`UyR1as4w|^ zZm7)Qv>{TehMLZn$likV7lh6*DbGtFyLwCZFB$2Nn+>BH0XSBuD)OWj0Qd8 literal 0 HcmV?d00001 diff --git a/docs/assets/local.css b/docs/assets/local.css new file mode 100644 index 00000000..ae9c403e --- /dev/null +++ b/docs/assets/local.css @@ -0,0 +1,39 @@ +/* With thanks to the excellent paperless-ngx project for the inspiration */ +/* See https://docs.paperless-ngx.com/ for more information */ + +:root > * { + --md-primary-fg-color: #2d4159; + --md-primary-fg-color--dark: #2d4159; + --md-primary-fg-color--light: #2d4159; + --md-accent-fg-color: #4e6683; + --md-typeset-a-color: #2d3159; +} + +@media (min-width: 400px) { + .grid-left { + width: 33%; + float: left; + } + + .grid-right { + width: 62%; + margin-left: 4%; + float: left; + } +} + +.grid-right > p { + margin-bottom: 2rem; +} + +.grid-left p { + margin: 0; +} + +.index-callout { + margin-right: .5rem; +} + +.clear { + clear: both; +} diff --git a/docs/assets/logo-shield-white.svg b/docs/assets/logo-shield-white.svg new file mode 100644 index 00000000..ee15c6fe --- /dev/null +++ b/docs/assets/logo-shield-white.svg @@ -0,0 +1,82 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 00000000..1c09f22a --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,243 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #2D4159 + #3D4756 + #A1ACBD + #4D3D26 + #7F6C54 + + + diff --git a/docs/index.md b/docs/index.md index aef29c84..b5684334 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,22 @@ -AdminerEvo is a web-based database management interface, with a focus on -security, user experience, performance, functionality and size. +
+![image](assets/logo.svg){.index-logo} +
+
+

+AdminerEvo is a web-based database management interface, with a focus on +security, user experience, performance, functionality and size. +

+ +

It is available for download as a single self-contained PHP file, making it easy to deploy anywhere. +

+ +[Download](https://github.com/adminerevo/adminerevo){ .md-button .md-button--secondary target=\_blank } +
+ +
AdminerEvo works out of the box with MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, Oracle, Elasticsearch and MongoDB. In addition, there are plugins for diff --git a/mkdocs.yml b/mkdocs.yml index baaa7cc7..a499b5b5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,11 +5,18 @@ nav: - Home: index.md theme: name: material + logo: assets/logo-shield-white.svg features: - navigation.tabs - navigation.top - toc.integrate - content.code.annotate + favicon: assets/favicon.png +extra_css: + - assets/local.css +markdown_extensions: + - attr_list + - md_in_html repo_url: https://github.com/adminerevo/adminerevo extra: social: