beenull/adminerevo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: prettify & add logo

Browse source 
Thanks to paperless-ngx for the inspiration!

https://github.com/paperless-ngx/paperless-ngx/tree/dev/docs
This commit is contained in:
Gerry Demaret 2023-07-20 16:12:35 +02:00
parent ccae72f2fa
commit 58b76d85be
6 changed files with 387 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/assets/favicon.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.4 KiB

39
docs/assets/local.css Normal file
View file

@ -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;
}

82
docs/assets/logo-shield-white.svg Normal file
View file

@ -0,0 +1,82 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="80.355743mm"
height="95.871567mm"
viewBox="0 0 80.355743 95.871567"
version="1.1"
id="svg639"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<defs
id="defs636" />
<g
id="layer1"
transform="translate(-18.448379,-10.98806)">
<g
id="g922"
transform="translate(-46.372995,-113.33478)">
<path
d="m 103.41,219.69 c -5.8574,-2.8071 -15.54,-10.873 -20.554,-17.123 -8.4331,-10.511 -13.554,-22 -16.256,-36.469 -0.61313,-3.2837 -0.94886,-7.2042 -1.3892,-16.222 -0.49913,-10.223 -0.51449,-13.203 -0.06891,-13.372 0.21381,-0.0812 2.4952,-0.48891 5.0697,-0.9064 13.6,-2.2054 20.623,-4.4565 32.562,-10.438 2.405,-1.2048 2.0374,-1.2525 6.2745,0.81404 11.41,5.5651 17.35,7.4133 30.893,9.6133 1.4204,0.23065 3.1637,0.5438 3.8739,0.6957 l 1.2913,0.27615 0.0503,1.1299 c 0.18503,4.1624 -0.92338,23 -1.6052,27.279 -3.0098,18.889 -11.655,34.733 -25.401,46.551 -5.2062,4.476 -7.3971,6.017 -11.166,7.8534 -2.1324,1.0391 -2.0779,1.0343 -3.5755,0.3166 z m 2.9787,-3.3031 c 6.1816,-2.8968 15.622,-10.943 20.558,-17.522 7.8262,-10.432 12.201,-20.542 14.378,-33.229 0.75313,-4.3896 1.7534,-20.732 1.5769,-25.763 l -0.0537,-1.5295 -1.5334,-0.2868 c -0.84339,-0.1578 -2.6956,-0.46995 -4.116,-0.69376 -11.476,-1.8083 -17.455,-3.6872 -28.486,-8.9523 -3.9955,-1.9071 -3.5582,-1.8595 -5.9706,-0.65024 -10.907,5.4675 -17.902,7.6897 -30.755,9.7708 -2.4858,0.4025 -4.6474,0.77143 -4.8036,0.81989 -0.32192,0.0998 -0.3193,0.30415 0.13497,10.557 0.44397,10.021 0.80438,14.248 1.5136,17.752 4.0571,20.047 12.361,33.554 28.093,45.694 2.0354,1.5708 7.3043,4.6699 7.9393,4.6699 0.0905,0 0.7763,-0.2867 1.524,-0.63714 z"
fill="#2d4159"
stroke-width="0"
id="path10"
style="fill:#ffffff;fill-opacity:1" />
<g
fill="none"
stroke="#2d4159"
stroke-linecap="round"
id="g18">
<path
d="m 117.12,167.89 h 4.71837 5.83663"
stroke-width="1.5366"
id="path12"
style="stroke:#ffffff;stroke-opacity:1" />
<path
d="M 82.309,167.91 H 98.145"
stroke-width="1.5366"
id="path14"
style="stroke:#ffffff;stroke-opacity:1" />
<path
d="m 117.21,173.98 c 3.4115,-0.009 6.822,-0.0178 8.5265,2.5195 1.7045,2.5373 1.7043,7.6198 1.704,12.701"
stroke-linejoin="round"
stroke-width="2.0479"
id="path16"
style="stroke:#ffffff;stroke-opacity:1" />
</g>
<a
transform="matrix(1.3101,0,0,1.3101,-32.778,-49.614)"
stroke-width="2.2613"
id="a22">
<path
d="m 102.94,183.03 c -3.5765,-0.48481 -6.4446,-3.0846 -7.2878,-6.6062 -0.24955,-1.0422 -0.24955,-15.526 0,-16.569 0.78951,-3.2971 3.3213,-5.7688 6.6636,-6.5054 0.90662,-0.1998 4.7806,-0.1998 5.6872,0 3.3422,0.73656 5.8741,3.2083 6.6636,6.5054 0.24956,1.0422 0.24956,15.526 0,16.569 -0.78643,3.2843 -3.2115,5.8758 -6.5248,6.608 -0.62799,0.13877 -4.4,0.10692 -5.2017,-0.002 z m 4.8475,-1.2499 c 3.0163,-0.68834 5.2113,-2.9219 5.7878,-5.8896 0.10298,-0.53012 0.11102,-0.88647 0.11102,-4.9205 v -4.349 h -17.054 v 4.349 c 0,4.034 0.008,4.3904 0.11102,4.9205 0.60507,3.1148 3.0017,5.4265 6.1674,5.9488 0.72013,0.1188 4.2865,0.0756 4.8767,-0.0591 z m -3.2122,-17.428 c 0,-1.1003 0,-1.1003 -0.1459,-1.1668 -0.23048,-0.10501 -0.66958,-0.53783 -0.80808,-0.7965 -0.1736,-0.32424 -0.22738,-3.2901 -0.0683,-3.7689 0.11347,-0.34163 0.48553,-0.78056 0.79582,-0.93886 l 0.2265,-0.11555 v -3.2264 l -0.77385,0.0317 c -3.5466,0.14528 -6.388,2.5676 -7.058,6.0171 -0.0973,0.50068 -0.11102,0.84993 -0.11102,2.818 v 2.2465 h 7.9429 z m 9.111,-1.1462 c 0,-1.9681 -0.0138,-2.3173 -0.11102,-2.818 -0.6701,-3.4496 -3.5114,-5.8718 -7.058,-6.0171 l -0.77385,-0.0317 v 3.2264 l 0.2265,0.11555 c 0.30422,0.1552 0.67838,0.59148 0.79118,0.92253 0.1538,0.45138 0.13354,3.2291 -0.0267,3.6574 -0.12251,0.32742 -0.54083,0.78574 -0.84273,0.9233 -0.14828,0.0676 -0.14828,0.0676 -0.14828,1.1678 v 1.1003 h 7.9429 z"
fill="#2d4159"
stroke-width="2.2613"
id="path20"
style="fill:#ffffff;fill-opacity:1" />
</a>
<g
fill="none"
stroke="#2d4159"
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="2.0479"
id="g30"
style="stroke:#ffffff;stroke-opacity:1">
<path
d="m 92.778,174.02 c -3.4115,-0.009 -6.8219,-0.0178 -8.5265,2.5195 -1.7046,2.5373 -1.7043,7.6198 -1.704,12.701"
id="path24"
style="stroke:#ffffff;stroke-opacity:1" />
<path
d="m 117.22,163.17 c 3.4115,0.009 6.822,0.0178 8.5265,-2.5195 1.7046,-2.5373 1.7043,-7.6198 1.704,-12.701"
id="path26"
style="stroke:#ffffff;stroke-opacity:1" />
<path
d="m 92.793,163.13 c -3.4115,0.009 -6.8219,0.0178 -8.5265,-2.5195 -1.7046,-2.5373 -1.7043,-7.6198 -1.704,-12.701"
id="path28"
style="stroke:#ffffff;stroke-opacity:1" />
</g>
</g>
</g>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 5.1 KiB

243
docs/assets/logo.svg Normal file
View file

@ -0,0 +1,243 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
width="206.51945mm"
height="134.02074mm"
version="1.1"
viewBox="0 0 206.51945 134.02074"
id="svg70"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:dc="http://purl.org/dc/elements/1.1/">
<defs
id="defs74" />
<metadata
id="metadata2">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
</cc:Work>
</rdf:RDF>
</metadata>
<g
transform="translate(-4.679738,-130.17963)"
id="g34">
<g
id="g363"
transform="translate(-1.3484317,-0.09581118)">
<g
transform="translate(1.0611,5.9526)"
id="g32">
<g
aria-label="ADMINEREVO"
id="text8"
style="font-size:30.787px;line-height:1.25;font-family:'Azeri Sans';fill:#2d4159;stroke-width:0.76968">
<path
d="m 15.249447,238.45529 -4.118964,11.16931 h 8.252961 z m -1.71373,-2.99151 h 3.442492 l 8.553615,22.44384 h -3.15687 l -2.044449,-5.75753 H 10.213487 l -2.0444489,5.75753 H 4.9670697 Z"
id="path10677" />
<path
d="m 31.845565,237.95921 v 17.45298 h 3.667983 q 4.645109,0 6.794787,-2.10458 2.164711,-2.10458 2.164711,-6.64446 0,-4.50981 -2.164711,-6.59936 -2.149678,-2.10458 -6.794787,-2.10458 z m -3.036608,-2.49543 h 6.238577 q 6.524198,0 9.575839,2.72092 3.051641,2.70589 3.051641,8.47845 0,5.80263 -3.066673,8.52355 -3.066674,2.72092 -9.560807,2.72092 h -6.238577 z"
id="path10679" />
<path
d="m 52.515548,235.46378 h 4.524847 l 5.727464,15.27324 5.75753,-15.27324 h 4.524847 v 22.44384 h -2.961444 v -19.70789 l -5.787596,15.3935 h -3.051641 l -5.787595,-15.3935 v 19.70789 h -2.946412 z"
id="path10681" />
<path
d="m 79.078353,235.46378 h 3.036608 v 22.44384 h -3.036608 z"
id="path10683" />
<path
d="m 88.158118,235.46378 h 4.088899 l 9.951653,18.77586 v -18.77586 h 2.94642 v 22.44384 h -4.0889 l -9.95166,-18.77586 v 18.77586 h -2.946412 z"
id="path10685" />
<path
d="m 111.18823,235.46378 h 14.19088 v 2.55556 h -11.15427 v 6.64446 h 10.68826 v 2.55556 h -10.68826 v 8.1327 h 11.42486 v 2.55556 h -14.46147 z"
id="path10687" />
<path
d="m 141.28373,247.38472 q 0.97713,0.33072 1.89412,1.41308 0.93203,1.08235 1.86406,2.97648 l 3.08171,6.13334 h -3.2621 l -2.87125,-5.75753 q -1.11242,-2.2549 -2.16471,-2.99151 -1.03726,-0.7366 -2.84118,-0.7366 h -3.3072 v 9.48564 h -3.03661 v -22.44384 h 6.85492 q 3.84837,0 5.7425,1.6085 1.89412,1.6085 1.89412,4.85557 0,2.11961 -0.99216,3.51765 -0.97713,1.39804 -2.85622,1.93922 z m -7.60655,-9.42551 v 7.96734 h 3.81831 q 2.19477,0 3.3072,-1.00719 1.12745,-1.02223 1.12745,-2.99151 0,-1.96929 -1.12745,-2.96145 -1.11243,-1.00719 -3.3072,-1.00719 z"
id="path10689" />
<path
d="M 152.03212,235.46378 H 166.223 v 2.55556 h -11.15427 v 6.64446 h 10.68826 v 2.55556 h -10.68826 v 8.1327 h 11.42486 v 2.55556 h -14.46147 z"
id="path10691" />
<path
d="m 177.27205,257.90762 -8.56865,-22.44384 h 3.1719 l 7.11048,18.89612 7.1255,-18.89612 h 3.15687 l -8.55361,22.44384 z"
id="path10693" />
<path
d="m 201.11394,237.52326 q -3.30719,0 -5.26145,2.46537 -1.93922,2.46536 -1.93922,6.71962 0,4.23923 1.93922,6.70459 1.95426,2.46537 5.26145,2.46537 3.3072,0 5.23139,-2.46537 1.93922,-2.46536 1.93922,-6.70459 0,-4.25426 -1.93922,-6.71962 -1.92419,-2.46537 -5.23139,-2.46537 z m 0,-2.46536 q 4.72028,0 7.54643,3.1719 2.82615,3.15687 2.82615,8.47845 0,5.30655 -2.82615,8.47845 -2.82615,3.15687 -7.54643,3.15687 -4.7353,0 -7.57648,-3.15687 -2.82615,-3.15687 -2.82615,-8.47845 0,-5.32158 2.82615,-8.47845 2.84118,-3.1719 7.57648,-3.1719 z"
id="path10695" />
</g>
<path
d="m 103.41,219.69 c -5.8574,-2.8071 -15.54,-10.873 -20.554,-17.123 -8.4331,-10.511 -13.554,-22 -16.256,-36.469 -0.61313,-3.2837 -0.94886,-7.2042 -1.3892,-16.222 -0.49913,-10.223 -0.51449,-13.203 -0.06891,-13.372 0.21381,-0.0812 2.4952,-0.48891 5.0697,-0.9064 13.6,-2.2054 20.623,-4.4565 32.562,-10.438 2.405,-1.2048 2.0374,-1.2525 6.2745,0.81404 11.41,5.5651 17.35,7.4133 30.893,9.6133 1.4204,0.23065 3.1637,0.5438 3.8739,0.6957 l 1.2913,0.27615 0.0503,1.1299 c 0.18503,4.1624 -0.92338,23 -1.6052,27.279 -3.0098,18.889 -11.655,34.733 -25.401,46.551 -5.2062,4.476 -7.3971,6.017 -11.166,7.8534 -2.1324,1.0391 -2.0779,1.0343 -3.5755,0.3166 z m 2.9787,-3.3031 c 6.1816,-2.8968 15.622,-10.943 20.558,-17.522 7.8262,-10.432 12.201,-20.542 14.378,-33.229 0.75313,-4.3896 1.7534,-20.732 1.5769,-25.763 l -0.0537,-1.5295 -1.5334,-0.2868 c -0.84339,-0.1578 -2.6956,-0.46995 -4.116,-0.69376 -11.476,-1.8083 -17.455,-3.6872 -28.486,-8.9523 -3.9955,-1.9071 -3.5582,-1.8595 -5.9706,-0.65024 -10.907,5.4675 -17.902,7.6897 -30.755,9.7708 -2.4858,0.4025 -4.6474,0.77143 -4.8036,0.81989 -0.32192,0.0998 -0.3193,0.30415 0.13497,10.557 0.44397,10.021 0.80438,14.248 1.5136,17.752 4.0571,20.047 12.361,33.554 28.093,45.694 2.0354,1.5708 7.3043,4.6699 7.9393,4.6699 0.0905,0 0.7763,-0.2867 1.524,-0.63714 z"
fill="#2d4159"
stroke-width="0"
id="path10" />
<g
fill="none"
stroke="#2d4159"
stroke-linecap="round"
id="g18">
<path
d="m 117.12,167.89 h 10.555"
stroke-width="1.5366"
id="path12" />
<path
d="M 82.309,167.91 H 98.145"
stroke-width="1.5366"
id="path14" />
<path
d="m 117.21,173.98 c 3.4115,-0.009 6.822,-0.0178 8.5265,2.5195 1.7045,2.5373 1.7043,7.6198 1.704,12.701"
stroke-linejoin="round"
stroke-width="2.0479"
id="path16" />
</g>
<a
transform="matrix(1.3101,0,0,1.3101,-32.778,-49.614)"
stroke-width="2.2613"
id="a22">
<path
d="m 102.94,183.03 c -3.5765,-0.48481 -6.4446,-3.0846 -7.2878,-6.6062 -0.24955,-1.0422 -0.24955,-15.526 0,-16.569 0.78951,-3.2971 3.3213,-5.7688 6.6636,-6.5054 0.90662,-0.1998 4.7806,-0.1998 5.6872,0 3.3422,0.73656 5.8741,3.2083 6.6636,6.5054 0.24956,1.0422 0.24956,15.526 0,16.569 -0.78643,3.2843 -3.2115,5.8758 -6.5248,6.608 -0.62799,0.13877 -4.4,0.10692 -5.2017,-0.002 z m 4.8475,-1.2499 c 3.0163,-0.68834 5.2113,-2.9219 5.7878,-5.8896 0.10298,-0.53012 0.11102,-0.88647 0.11102,-4.9205 v -4.349 h -17.054 v 4.349 c 0,4.034 0.008,4.3904 0.11102,4.9205 0.60507,3.1148 3.0017,5.4265 6.1674,5.9488 0.72013,0.1188 4.2865,0.0756 4.8767,-0.0591 z m -3.2122,-17.428 c 0,-1.1003 0,-1.1003 -0.1459,-1.1668 -0.23048,-0.10501 -0.66958,-0.53783 -0.80808,-0.7965 -0.1736,-0.32424 -0.22738,-3.2901 -0.0683,-3.7689 0.11347,-0.34163 0.48553,-0.78056 0.79582,-0.93886 l 0.2265,-0.11555 v -3.2264 l -0.77385,0.0317 c -3.5466,0.14528 -6.388,2.5676 -7.058,6.0171 -0.0973,0.50068 -0.11102,0.84993 -0.11102,2.818 v 2.2465 h 7.9429 z m 9.111,-1.1462 c 0,-1.9681 -0.0138,-2.3173 -0.11102,-2.818 -0.6701,-3.4496 -3.5114,-5.8718 -7.058,-6.0171 l -0.77385,-0.0317 v 3.2264 l 0.2265,0.11555 c 0.30422,0.1552 0.67838,0.59148 0.79118,0.92253 0.1538,0.45138 0.13354,3.2291 -0.0267,3.6574 -0.12251,0.32742 -0.54083,0.78574 -0.84273,0.9233 -0.14828,0.0676 -0.14828,0.0676 -0.14828,1.1678 v 1.1003 h 7.9429 z"
fill="#2d4159"
stroke-width="2.2613"
id="path20" />
</a>
<g
fill="none"
stroke="#2d4159"
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="2.0479"
id="g30">
<path
d="m 92.778,174.02 c -3.4115,-0.009 -6.8219,-0.0178 -8.5265,2.5195 -1.7046,2.5373 -1.7043,7.6198 -1.704,12.701"
id="path24" />
<path
d="m 117.22,163.17 c 3.4115,0.009 6.822,0.0178 8.5265,-2.5195 1.7046,-2.5373 1.7043,-7.6198 1.704,-12.701"
id="path26" />
<path
d="m 92.793,163.13 c -3.4115,0.009 -6.8219,0.0178 -8.5265,-2.5195 -1.7046,-2.5373 -1.7043,-7.6198 -1.704,-12.701"
id="path28" />
</g>
</g>
</g>
</g>
<g
transform="translate(-4.679738,-130.17963)"
display="none"
id="g68">
<rect
x="37.511002"
y="17.773001"
width="31.056999"
height="30.308001"
fill="#2d4159"
opacity="0.997"
style="paint-order:markers stroke fill"
id="rect36" />
<rect
x="83.348"
y="17.773001"
width="31.056999"
height="30.308001"
fill="#3d4756"
opacity="0.997"
style="paint-order:markers stroke fill"
id="rect38" />
<rect
x="127.88"
y="17.773001"
width="31.056999"
height="30.308001"
fill="#a1acbd"
opacity="0.997"
style="paint-order:markers stroke fill"
id="rect40" />
<rect
x="37.137001"
y="78.203003"
width="31.056999"
height="30.308001"
fill="#4d3d26"
opacity="0.997"
style="paint-order:markers stroke fill"
id="rect42" />
<rect
x="87.837997"
y="78.203003"
width="31.056999"
height="30.308001"
fill="#7f6c54"
opacity="0.997"
style="paint-order:markers stroke fill"
id="rect44" />
<g
fill="#000000"
font-family="sans-serif"
id="g66">
<text
x="34.926155"
y="61.18372"
font-size="7.0851px"
stroke-width="0.17713"
style="line-height:1.25"
xml:space="preserve"
id="text48"><tspan
x="34.926155"
y="61.18372"
stroke-width="0.17713"
id="tspan46">#2D4159</tspan></text>
<text
transform="scale(0.99919,1.0008)"
x="82.517418"
y="61.134243"
font-size="7.0796px"
stroke-width="0.17699"
style="line-height:1.25"
xml:space="preserve"
id="text52"><tspan
x="82.517418"
y="61.134243"
stroke-width="0.17699"
id="tspan50">#3D4756</tspan></text>
<text
transform="scale(0.97899,1.0215)"
x="132.63629"
y="59.898193"
font-size="6.9365px"
stroke-width="0.17341"
style="line-height:1.25"
xml:space="preserve"
id="text56"><tspan
x="132.63629"
y="59.898193"
stroke-width="0.17341"
id="tspan54">#A1ACBD</tspan></text>
<text
transform="scale(0.98512,1.0151)"
x="37.356224"
y="117.31787"
font-size="6.9799px"
stroke-width="0.1745"
style="line-height:1.25"
xml:space="preserve"
id="text60"><tspan
x="37.356224"
y="117.31787"
stroke-width="0.1745"
id="tspan58">#4D3D26</tspan></text>
<text
transform="scale(1.013,0.98716)"
x="86.020058"
y="120.63979"
font-size="7.1775px"
stroke-width="0.17944"
style="line-height:1.25"
xml:space="preserve"
id="text64"><tspan
x="86.020058"
y="120.63979"
stroke-width="0.17944"
id="tspan62">#7F6C54</tspan></text>
</g>
</g>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 11 KiB

18
docs/index.md
View file

@ -1,8 +1,22 @@
AdminerEvo is a web-based database management interface, with a focus on
security, user experience, performance, functionality and size.
<div class="grid-left" markdown>
![image](assets/logo.svg){.index-logo}
</div>
<div class="grid-right" markdown>
<p>
<b>AdminerEvo</b> is a web-based database management interface, with a focus on
security, user experience, performance, functionality and size.
</p>
<p>
It is available for download as a single self-contained PHP file, making it easy
to deploy anywhere.
</p>
[Download](https://github.com/adminerevo/adminerevo){ .md-button .md-button--secondary target=\_blank }
</div>
<div class="clear"></div>
AdminerEvo works out of the box with MySQL, MariaDB, PostgreSQL, SQLite, MS SQL,
Oracle, Elasticsearch and MongoDB. In addition, there are plugins for

7
mkdocs.yml
View file

@ -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: