diff options
author | sptaule <lecas83@gmail.com> | 2022-01-27 18:10:37 +0100 |
---|---|---|
committer | sptaule <lecas83@gmail.com> | 2022-01-27 18:10:37 +0100 |
commit | 1da8b90340235753b935a880d797cb796700d151 (patch) | |
tree | e6c98c0999eb3b58e3ebfd72b88c4379a8fa51d0 | |
parent | a8d6c4635cf4e49320ebee8ee6f348769b65ffa8 (diff) | |
download | garagehq.deuxfleurs.fr-1da8b90340235753b935a880d797cb796700d151.tar.gz garagehq.deuxfleurs.fr-1da8b90340235753b935a880d797cb796700d151.zip |
Doc refactor, doc and index QoL, fix search: working on every page
-rwxr-xr-x | config.toml | 2 | ||||
-rw-r--r-- | content/documentation/_index.md | 2 | ||||
-rw-r--r-- | content/documentation/quick-start/_index.md | 6 | ||||
-rw-r--r-- | content/documentation/quick_start.md (renamed from content/documentation/quick-start/overview.md) | 2 | ||||
-rwxr-xr-x | src/input.css | 2 | ||||
-rw-r--r-- | static/images/garage-logo-horizontal.svg | 132 | ||||
-rw-r--r-- | static/images/garage-logo-simple.svg | 98 | ||||
-rwxr-xr-x | static/js/site.js | 6 | ||||
-rwxr-xr-x | templates/base.html | 12 | ||||
-rw-r--r-- | templates/documentation.html | 2 | ||||
-rwxr-xr-x | templates/index.html | 24 | ||||
-rw-r--r-- | templates/partials/doc/global_toc.html | 18 | ||||
-rw-r--r-- | templates/partials/doc/page_toc.html | 6 | ||||
-rw-r--r-- | templates/partials/doc/toc_script.html | 23 | ||||
-rw-r--r-- | templates/partials/shared/nav.html | 16 |
15 files changed, 310 insertions, 41 deletions
diff --git a/config.toml b/config.toml index 64cddcc..5db7b77 100755 --- a/config.toml +++ b/config.toml @@ -68,6 +68,8 @@ webmanifest = "/icons/site.webmanifest" name = "Garage" description = "An open-source distributed storage service you can self-host to fullfill many needs" logo = "/images/garage-logo.svg" +logo_simple = "/images/garage-logo-simple.svg" +logo_horizontal = "/images/garage-logo-horizontal.svg" [extra.author] name = "Garage" diff --git a/content/documentation/_index.md b/content/documentation/_index.md index 68d1395..283c8f3 100644 --- a/content/documentation/_index.md +++ b/content/documentation/_index.md @@ -2,4 +2,4 @@ template = "documentation.html" page_template = "documentation.html" redirect_to = "documentation/quick-start/" -+++
\ No newline at end of file ++++ diff --git a/content/documentation/quick-start/_index.md b/content/documentation/quick-start/_index.md deleted file mode 100644 index b8ec473..0000000 --- a/content/documentation/quick-start/_index.md +++ /dev/null @@ -1,6 +0,0 @@ -+++ -title = "Quick Start" -weight = 1 -sort_by = "weight" -redirect_to = "documentation/quick-start/overview/" -+++
\ No newline at end of file diff --git a/content/documentation/quick-start/overview.md b/content/documentation/quick_start.md index 478e033..30cf2ee 100644 --- a/content/documentation/quick-start/overview.md +++ b/content/documentation/quick_start.md @@ -1,5 +1,5 @@ +++ -title = "Overview" +title = "Quick Start" weight = 5 +++ diff --git a/src/input.css b/src/input.css index b7582f7..52ec9f3 100755 --- a/src/input.css +++ b/src/input.css @@ -99,7 +99,7 @@ p > code, p > strong > code, li > code, li > strong > code { } .is-active { - @apply text-orange-600; + @apply text-garage-orange; } @layer utilities { diff --git a/static/images/garage-logo-horizontal.svg b/static/images/garage-logo-horizontal.svg new file mode 100644 index 0000000..9bf3293 --- /dev/null +++ b/static/images/garage-logo-horizontal.svg @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + width="53.778011mm" + height="17.799999mm" + viewBox="0 0 53.778011 17.799999" + version="1.1" + id="svg5" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg"> + <defs + id="defs2" /> + <g + id="layer1" + transform="translate(-50.429757,-152.34309)"> + <g + id="g2446" + transform="matrix(0.26458333,0,0,0.26458333,27.649536,132.01223)"> + <g + id="g6567" + transform="matrix(0.92473907,0,0,0.92473907,11.032718,11.165159)"> + <g + id="g7383" + transform="matrix(1.0300991,0,0,1.0300991,3.770254,-1.2763086)"> + <g + id="g7563" + transform="translate(-4.4654119e-6,0.53693799)"> + <g + id="g7533" + transform="translate(-2.0995769,-2.3051055)"> + <path + id="path8" + class="st0" + d="m 202.56631,104.04459 c 1.91913,0.0226 3.84227,-0.048 5.75858,0.0407 1.10992,0.0647 2.08169,0.96893 2.12552,2.09821 0.0576,2.83895 0.01,5.68171 0.0254,8.52216 0.0387,0.72125 -1.16554,0.55433 -1.65693,0.86227 -2.84639,0.78316 -5.8672,1.08468 -8.79355,0.62567 -2.48401,-0.4206 -4.607,-2.18507 -5.6512,-4.45399 -1.3326,-2.83308 -1.54654,-6.07759 -1.21852,-9.15366 0.29318,-2.57048 1.44845,-5.087404 3.4732,-6.747324 2.18417,-1.91934 5.23662,-2.62252 8.07889,-2.19703 2.06196,0.25939 4.06302,1.01333 5.76811,2.20419 -0.19449,1.20116 -0.88747,2.342733 -1.92914,2.990153 -1.86554,-1.368913 -4.2536,-2.121983 -6.56807,-1.871843 -2.02236,0.3166 -3.7626,1.874043 -4.28355,3.858414 -0.66626,2.35645 -0.66846,4.88015 -0.25232,7.28143 0.33705,1.92315 1.48217,3.89047 3.44592,4.49149 1.86015,0.60901 3.8467,0.22762 5.72889,-0.0627 0.0232,-1.64043 -0.0571,-3.28547 0.0646,-4.92211 0.0448,-0.38456 -0.69475,-0.10524 -1.00403,-0.19009 -1.00936,-0.0553 -2.11594,0.1939 -3.01531,-0.38583 -0.86022,-0.80391 -0.32729,-2.03804 -0.0965,-2.99015 z" + style="stroke-width:0.964566" /> + <path + id="path10" + class="st0" + d="m 227.35569,114.07607 c -0.0965,0.38583 -0.28937,0.77165 -0.57875,1.15748 -0.19291,0.38583 -0.48228,0.6752 -0.77164,0.86811 -1.25394,-0.0965 -2.31497,-0.77165 -2.99017,-1.92913 -1.15748,1.25393 -2.89369,2.02559 -4.62991,2.02559 -1.63978,0 -2.89371,-0.48229 -3.76182,-1.44685 -0.77166,-0.96457 -1.25394,-2.12205 -1.25394,-3.37598 0,-1.83268 0.57874,-3.18307 1.73622,-4.05118 1.35039,-0.96456 2.89371,-1.44685 4.53346,-1.35039 0.96458,0 1.92914,0 2.79726,0.0965 v -0.96457 c 0,-1.73622 -0.77166,-2.50787 -2.41143,-2.50787 -1.15747,0 -2.79724,0.38583 -4.91929,1.15748 -0.6752,-0.77165 -1.06102,-1.83268 -1.06102,-2.8937 2.2185,-0.964561 4.53347,-1.446851 6.94488,-1.446851 1.44686,-0.0965 2.79725,0.38583 3.95473,1.350401 0.96457,0.86811 1.5433,2.2185 1.5433,4.05117 v 6.55905 c -0.0965,1.44685 0.19291,2.2185 0.86812,2.70078 z m -8.10237,-0.77165 c 1.25394,-0.0965 2.41142,-0.57874 3.18308,-1.54331 v -2.79724 c -0.77166,-0.0965 -1.63977,-0.0965 -2.41143,-0.0965 -0.77165,-0.0965 -1.44684,0.19291 -2.02558,0.67519 -0.48229,0.48229 -0.67521,1.06103 -0.67521,1.73622 0,0.57874 0.19292,1.15748 0.57875,1.63976 0.38583,0.19292 0.86811,0.38583 1.35039,0.38583 z" + style="stroke-width:0.964566" /> + <path + id="path12" + class="st0" + d="m 229.96001,101.82609 c 0.0965,-0.38583 0.28937,-0.77165 0.57874,-1.15748 0.19292,-0.38583 0.48229,-0.675201 0.77165,-0.868111 1.63976,0.19291 2.8937,1.350391 3.37599,2.893701 0.86811,-1.92913 2.2185,-2.893701 4.14764,-2.893701 0.57874,0 1.25392,0.0965 1.83267,0.19291 0,1.350401 -0.28937,2.604331 -0.96456,3.761811 -0.48229,-0.0965 -0.96457,-0.19291 -1.44685,-0.19291 -1.3504,0 -2.31496,0.67519 -3.18308,2.12204 v 10.2244 c -0.67519,0.0965 -1.35039,0.19291 -1.92914,0.19291 -0.67518,0 -1.35038,-0.0965 -2.02558,-0.19291 v -10.80314 c 0,-1.5433 -0.38582,-2.60433 -1.15748,-3.27952 z" + style="stroke-width:0.964566" /> + <path + id="path14" + class="st0" + d="m 255.61749,114.07607 c -0.0965,0.38583 -0.28937,0.77165 -0.57874,1.15748 -0.19291,0.38583 -0.48228,0.6752 -0.77165,0.86811 -1.25394,-0.0965 -2.31496,-0.77165 -2.99017,-1.92913 -1.15747,1.25393 -2.89369,2.02559 -4.62992,2.02559 -1.63975,0 -2.8937,-0.48229 -3.7618,-1.44685 -0.77166,-0.96457 -1.25394,-2.12205 -1.25394,-3.37598 0,-1.83268 0.57874,-3.18307 1.73622,-4.05118 1.25393,-0.96456 2.8937,-1.44685 4.43701,-1.35039 0.96456,0 1.92914,0 2.79724,0.0965 v -0.96457 c 0,-1.73622 -0.77164,-2.50787 -2.41142,-2.50787 -1.15748,0 -2.79724,0.38583 -4.91929,1.15748 -0.6752,-0.77165 -1.06102,-1.83268 -1.06102,-2.8937 2.2185,-0.964561 4.53346,-1.446851 6.94488,-1.446851 1.44685,-0.0965 2.79725,0.38583 3.95473,1.350401 0.96456,0.86811 1.5433,2.2185 1.5433,4.05117 v 6.55905 c 0,1.44685 0.38583,2.2185 0.96457,2.70078 z m -8.10236,-0.77165 c 1.25393,-0.0965 2.41142,-0.57874 3.18307,-1.54331 v -2.79724 c -0.77165,-0.0965 -1.63977,-0.0965 -2.41142,-0.0965 -0.77165,-0.0965 -1.44686,0.19291 -2.02559,0.67519 -0.48228,0.48229 -0.67519,1.06103 -0.67519,1.73622 0,0.57874 0.19291,1.15748 0.57874,1.63976 0.38582,0.19292 0.8681,0.38583 1.35039,0.38583 z" + style="stroke-width:0.964566" /> + <path + id="path16" + class="st0" + d="m 259.57222,113.97962 c -0.96457,-1.44685 -1.44686,-3.47244 -1.44686,-6.07677 0,-2.60433 0.57875,-4.62991 1.83268,-6.07676 1.06103,-1.35039 2.70079,-2.218501 4.43701,-2.218501 1.63977,0 3.18307,0.578741 4.34055,1.639761 0.57874,-0.77165 1.54332,-1.253941 2.50787,-1.350391 0.38583,0.192911 0.6752,0.578741 0.86812,0.868111 0.19291,0.38582 0.38583,0.67519 0.57874,1.15747 -0.57874,0.48229 -0.86812,1.44685 -0.86812,2.79725 v 9.06691 c 0,3.37598 -0.57874,5.7874 -1.63975,7.23424 -1.06103,1.44685 -2.99017,2.12205 -5.49804,2.12205 -1.92914,0 -3.95472,-0.38583 -5.7874,-1.06102 0,-1.06103 0.28937,-2.12205 0.96457,-2.8937 1.35039,0.6752 2.79724,0.96457 4.34054,0.96457 1.44686,0 2.41143,-0.38583 2.89371,-1.06103 0.57874,-0.86811 0.86811,-1.92913 0.77165,-2.99015 v -1.25394 c -1.15748,0.96457 -2.50787,1.54331 -4.05118,1.54331 -1.73622,-0.0965 -3.37599,-0.96457 -4.24409,-2.41141 z m 8.19882,-2.60433 v -7.42716 c -0.6752,-0.77165 -1.73622,-1.25393 -2.79725,-1.35039 -0.86811,0 -1.73621,0.57874 -2.12205,1.35039 -0.57874,1.25394 -0.86811,2.60433 -0.77165,3.95472 0,1.73622 0.19291,2.99016 0.67519,3.76181 0.28938,0.67519 1.06103,1.15748 1.83268,1.25393 1.3504,0 2.50788,-0.57874 3.18308,-1.5433 z" + style="stroke-width:0.964566" /> + <path + id="path18-7" + class="st0" + d="m 288.21985,109.25324 h -8.97047 c 0,1.06103 0.28937,2.02559 0.86811,2.8937 0.48228,0.6752 1.35039,1.06102 2.60432,1.06102 1.44686,-0.0965 2.89371,-0.48228 4.2441,-1.15748 0.6752,0.6752 1.06102,1.54331 1.15748,2.41142 -1.83267,1.25393 -3.95472,1.92913 -6.17323,1.83267 -2.41141,0 -4.14764,-0.77165 -5.20865,-2.31495 -1.06104,-1.54331 -1.54331,-3.5689 -1.54331,-6.07677 0,-2.50787 0.57873,-4.53346 1.73622,-6.07676 1.15747,-1.54331 2.99015,-2.411421 4.91928,-2.314961 2.12206,0 3.76182,0.675201 4.9193,1.929131 1.15748,1.35039 1.83267,3.08661 1.73622,4.91929 0,0.96456 -0.0965,1.92913 -0.28937,2.89369 z m -6.17323,-6.84841 c -1.73622,0 -2.70079,1.35039 -2.79724,3.95472 h 5.59448 v -0.38583 c 0,-0.86811 -0.19292,-1.83267 -0.67519,-2.60433 -0.48228,-0.67519 -1.3504,-0.96456 -2.12205,-0.96456 z" + style="stroke-width:0.964566" /> + </g> + <g + id="g7544" + transform="translate(2.0995769,2.0995769)"> + <path + id="path6" + d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z" + style="stroke-width:0.964566" /> + <path + id="path26" + class="st3" + d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z" + style="stroke-width:0.964566" /> + <ellipse + id="circle28" + class="st3" + cx="123.42634" + cy="120.26041" + rx="9.645668" + ry="9.6456566" + style="stroke-width:0.964566" /> + <path + id="path6-0" + d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z" + style="stroke-width:0.964566" /> + <path + id="path24-3-6-9" + class="st4" + d="m 123.0405,70.199461 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,89.973057 c -0.771652,0.289369 -1.157479,1.253935 -0.868109,2.025588 0,0 0,0 0,0 0,0.09646 0,0.09646 0.09646,0.192913 l 6.848424,13.503922 h 5.980314 l -0.86811,-4.72638 c -0.09646,-0.38582 -0.675197,-3.086605 -1.253937,-5.015736 l 19.966532,6.269676 c 0.28937,1.25394 0.57874,2.41141 1.06103,3.47244 h 32.31298 c 0.38582,-1.06103 0.67519,-2.2185 0.86811,-3.47244 l 19.87007,-6.17322 c -0.57873,1.929131 -1.15747,4.62992 -1.25393,5.01574 l -0.86812,4.72637 h 5.98032 l 6.75197,-13.407459 0.0965,-0.09646 0.0965,-0.192913 c 0,0 0,0 0,0 0.0965,-0.192913 0.0965,-0.28937 0.0965,-0.482283 0,-0.675196 -0.38583,-1.253935 -0.96457,-1.543305 l -42.6339,-18.905486 c -1.54332,-0.675196 -2.99017,-1.061022 -4.53347,-0.964566 z" + style="stroke-width:0.964566" /> + <path + id="path24-3-2" + class="st0" + d="m 123.0405,79.073465 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,98.847061 c -0.771652,0.289369 -1.157479,1.253939 -0.868109,2.025589 0,0 0,0 0,0 0,0.0965 0,0.0965 0.09646,0.19291 l 3.665353,7.3307 h 7.909449 c -0.289371,-1.06102 -0.578742,-2.31496 -0.964568,-3.56889 l 11.285433,3.56889 h 51.507866 l 11.28542,-3.56889 c -0.38581,1.15748 -0.67518,2.50787 -0.96455,3.56889 h 7.90943 l 3.66536,-7.23424 0.0965,-0.0965 0.0965,-0.19291 c 0,0 0,0 0,0 0.0965,-0.19291 0.0965,-0.28937 0.0965,-0.48228 0,-0.6752 -0.38582,-1.25394 -0.96457,-1.543309 L 127.47751,79.941574 c -1.44686,-0.578739 -2.89371,-0.868109 -4.43701,-0.868109 z" + style="stroke-width:0.964566" /> + <path + id="path24-0" + class="st4" + d="m 171.07592,109.45728 c 0,0.19292 0,0.28937 -0.0965,0.48229 0,0 0,0 0,0 l -0.0965,0.19291 v 0 l -0.0965,0.0965 -10.32087,20.44879 c -1.44684,2.79724 -4.05116,2.70078 -3.66533,-0.0965 l 2.12203,-11.57479 c 0.0965,-0.38582 0.6752,-3.08661 1.25394,-5.01574 l -19.87014,6.17322 c -3.08661,20.35234 -29.90156,20.64171 -34.24212,0 L 86.0974,113.89428 c 0.578741,1.92914 1.157481,4.62992 1.253938,5.01575 l 2.122046,11.57478 c 0.482284,2.8937 -2.218503,2.99016 -3.665353,0.0965 L 75.390897,110.03602 c 0,-0.0964 -0.09646,-0.0964 -0.09646,-0.19291 -0.385827,-0.77165 0,-1.73622 0.771653,-2.02559 0,0 0,0 0,0 l 42.63386,-18.905486 c 2.70078,-1.157478 5.88385,-1.157478 8.58464,0 l 42.63385,18.905486 c 0.77166,0.38583 1.15748,0.96457 1.15748,1.63976 z" + style="stroke-width:0.964566" /> + <path + id="path26-2" + class="st0" + d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z" + style="stroke-width:0.964566" /> + <ellipse + id="circle28-3" + class="st0" + cx="123.42634" + cy="120.26041" + rx="9.645668" + ry="9.6456566" + style="stroke-width:0.964566" /> + </g> + </g> + </g> + </g> + </g> + </g> + <style + type="text/css" + id="style2346"> + .st0{fill:#4E4E4E;} + .st1{fill:#FFD952;} + .st2{fill:#49C8FA;} + .st3{fill:#45C8FF;} + .st4{fill:#FF9329;} + .st5{fill:#3B2100;} + .st6{fill:#C3C3C3;} +</style> +</svg> diff --git a/static/images/garage-logo-simple.svg b/static/images/garage-logo-simple.svg new file mode 100644 index 0000000..85f5e19 --- /dev/null +++ b/static/images/garage-logo-simple.svg @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + width="26mm" + height="17.799999mm" + viewBox="0 0 26 17.799999" + version="1.1" + id="svg5" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg"> + <defs + id="defs2" /> + <g + id="layer1" + transform="translate(-50.429757,-152.34309)"> + <g + id="g2446" + transform="matrix(0.26458333,0,0,0.26458333,27.649536,132.01223)"> + <g + id="g6567" + transform="matrix(0.92473907,0,0,0.92473907,11.032718,11.165159)"> + <g + id="g7383" + transform="matrix(1.0300991,0,0,1.0300991,3.770254,-1.2763086)"> + <g + id="g7563" + transform="translate(-4.4654119e-6,0.53693799)"> + <g + id="g7544" + transform="translate(3.5654432,2.0995769)"> + <path + id="path6" + d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z" + style="stroke-width:0.964566" /> + <path + id="path26" + class="st3" + d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z" + style="stroke-width:0.964566" /> + <ellipse + id="circle28" + class="st3" + cx="123.42634" + cy="120.26041" + rx="9.645668" + ry="9.6456566" + style="stroke-width:0.964566" /> + <path + id="path6-0" + d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z" + style="stroke-width:0.964566" /> + <path + id="path24-3-6-9" + class="st4" + d="m 123.0405,70.199461 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,89.973057 c -0.771652,0.289369 -1.157479,1.253935 -0.868109,2.025588 0,0 0,0 0,0 0,0.09646 0,0.09646 0.09646,0.192913 l 6.848424,13.503922 h 5.980314 l -0.86811,-4.72638 c -0.09646,-0.38582 -0.675197,-3.086605 -1.253937,-5.015736 l 19.966532,6.269676 c 0.28937,1.25394 0.57874,2.41141 1.06103,3.47244 h 32.31298 c 0.38582,-1.06103 0.67519,-2.2185 0.86811,-3.47244 l 19.87007,-6.17322 c -0.57873,1.929131 -1.15747,4.62992 -1.25393,5.01574 l -0.86812,4.72637 h 5.98032 l 6.75197,-13.407459 0.0965,-0.09646 0.0965,-0.192913 c 0,0 0,0 0,0 0.0965,-0.192913 0.0965,-0.28937 0.0965,-0.482283 0,-0.675196 -0.38583,-1.253935 -0.96457,-1.543305 l -42.6339,-18.905486 c -1.54332,-0.675196 -2.99017,-1.061022 -4.53347,-0.964566 z" + style="stroke-width:0.964566" /> + <path + id="path24-3-2" + class="st0" + d="m 123.0405,79.073465 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,98.847061 c -0.771652,0.289369 -1.157479,1.253939 -0.868109,2.025589 0,0 0,0 0,0 0,0.0965 0,0.0965 0.09646,0.19291 l 3.665353,7.3307 h 7.909449 c -0.289371,-1.06102 -0.578742,-2.31496 -0.964568,-3.56889 l 11.285433,3.56889 h 51.507866 l 11.28542,-3.56889 c -0.38581,1.15748 -0.67518,2.50787 -0.96455,3.56889 h 7.90943 l 3.66536,-7.23424 0.0965,-0.0965 0.0965,-0.19291 c 0,0 0,0 0,0 0.0965,-0.19291 0.0965,-0.28937 0.0965,-0.48228 0,-0.6752 -0.38582,-1.25394 -0.96457,-1.543309 L 127.47751,79.941574 c -1.44686,-0.578739 -2.89371,-0.868109 -4.43701,-0.868109 z" + style="stroke-width:0.964566" /> + <path + id="path24-0" + class="st4" + d="m 171.07592,109.45728 c 0,0.19292 0,0.28937 -0.0965,0.48229 0,0 0,0 0,0 l -0.0965,0.19291 v 0 l -0.0965,0.0965 -10.32087,20.44879 c -1.44684,2.79724 -4.05116,2.70078 -3.66533,-0.0965 l 2.12203,-11.57479 c 0.0965,-0.38582 0.6752,-3.08661 1.25394,-5.01574 l -19.87014,6.17322 c -3.08661,20.35234 -29.90156,20.64171 -34.24212,0 L 86.0974,113.89428 c 0.578741,1.92914 1.157481,4.62992 1.253938,5.01575 l 2.122046,11.57478 c 0.482284,2.8937 -2.218503,2.99016 -3.665353,0.0965 L 75.390897,110.03602 c 0,-0.0964 -0.09646,-0.0964 -0.09646,-0.19291 -0.385827,-0.77165 0,-1.73622 0.771653,-2.02559 0,0 0,0 0,0 l 42.63386,-18.905486 c 2.70078,-1.157478 5.88385,-1.157478 8.58464,0 l 42.63385,18.905486 c 0.77166,0.38583 1.15748,0.96457 1.15748,1.63976 z" + style="stroke-width:0.964566" /> + <path + id="path26-2" + class="st0" + d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z" + style="stroke-width:0.964566" /> + <ellipse + id="circle28-3" + class="st0" + cx="123.42634" + cy="120.26041" + rx="9.645668" + ry="9.6456566" + style="stroke-width:0.964566" /> + </g> + </g> + </g> + </g> + </g> + </g> + <style + type="text/css" + id="style2346"> + .st0{fill:#4E4E4E;} + .st1{fill:#FFD952;} + .st2{fill:#49C8FA;} + .st3{fill:#45C8FF;} + .st4{fill:#FF9329;} + .st5{fill:#3B2100;} + .st6{fill:#C3C3C3;} +</style> +</svg> diff --git a/static/js/site.js b/static/js/site.js index f764289..d8e0d69 100755 --- a/static/js/site.js +++ b/static/js/site.js @@ -112,7 +112,7 @@ function makeTeaser(body, terms) { function formatSearchResultItem(item, terms) { return ( - `<a href='${item.ref}' class='group flex flex-col space-y-2 hover:bg-gray-100 p-2 rounded'>` + + `<a href='${item.ref}' class='group flex flex-col space-y-2 hover:bg-gray-100 p-2 rounded focus:outline outline-garage-orange'>` + `<h1 class='text-garage-orange font-semibold'>` + `${item.doc.title}` + `</h1>` + `<div class='content mt-2'>` + `${makeTeaser(item.doc.body, terms)}` + @@ -168,9 +168,11 @@ function search() { } function openSearchModal() { + var baseUrl = window.location.protocol + "//" + window.location.host; + var indexScriptPath = baseUrl + '/search_index.en.js'; if (indexScriptLoaded === false) { var indexScript = document.createElement('script'); - indexScript.setAttribute('src', './search_index.en.js'); + indexScript.setAttribute('src', indexScriptPath); document.head.appendChild(indexScript); indexScriptLoaded = true; } diff --git a/templates/base.html b/templates/base.html index 8170b44..41121c3 100755 --- a/templates/base.html +++ b/templates/base.html @@ -18,9 +18,13 @@ </div> {% block search %} - <section id="search-modal" class="modal hidden bg-gray-50 w-5/6 md:w-4/5 lg:w-3/4 xl:w-2/3 2xl:w-1/2 absolute top-20 left-1/2 transform -translate-x-1/2 shadow-xl rounded-lg"> - <div class="p-2 md:p-4 xl:p-8"> + <section id="search-modal" class="modal hidden bg-gradient-to-b from-gray-50 to-gray-100 w-5/6 md:w-4/5 lg:w-3/4 xl:w-2/3 2xl:w-1/2 absolute top-20 left-1/2 transform -translate-x-1/2 shadow-2xl rounded-lg"> + <div class="p-2 md:p-4 xl:p-8 border-8 border-gray-300 rounded-lg shadow-inner" style="min-height:30vh;"> <section class="relative flex flex-col items-center justify-center"> + <div class="flexs items-center justify-center"> + <span class="text-xl inline-block font-thin">Search</span> + <span class="font-normal inline-block text-xs text-gray-500">(alt + S)</span> + </div> <div class="field mt-8 md:mt-0 mb-2"> <div class="control"> <input @@ -30,10 +34,10 @@ </div> </div> <div class="search-results hidden mt-8 p-2 md:p-4 w-full bg-white rounded shadow"> - <div class="search-results__items max-h-96 overflow-y-scroll p-2 md:p-4"></div> + <div class="search-results__items max-h-96 overflow-y-scroll p-2 md:p-4 focus:outline outline-garage-orange"></div> </div> </section> - <button aria-label="close" id="close-modal-btn" class="absolute top-2 right-2 flex items-center group rounded-full shadow-inner bg-gray-300 border border-transparent hover:border-gray-500 bg-opacity-50 p-2"> + <button aria-label="close" id="close-modal-btn" class="absolute top-4 right-4 flex items-center group rounded-full shadow-inner bg-gray-300 border border-transparent hover:border-gray-500 bg-opacity-50 p-2"> <svg id="close-modal-btn-icon" class="w-6 h-6 text-gray-400" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M6 18L18 6M6 6l12 12"></path></svg> <small class="text-xs text-gray-400">(Esc)</small> </button> diff --git a/templates/documentation.html b/templates/documentation.html index 70ef6a3..09dcad9 100644 --- a/templates/documentation.html +++ b/templates/documentation.html @@ -9,7 +9,7 @@ <section class="section overflow-x-hidden"> <div class="grid grid-cols-1 xl:grid-cols-5"> {% include "partials/doc/global_toc.html" %} - <div class="col-span-full xl:col-span-3"> + <div class="col-span-full xl:col-span-3" style="min-height:85vh;"> <article class="box my-12 px-6 lg:px-8 xl:px-12"> <div class="flex flex-col bg-gray-100 rounded-r shadow-sm w-full xl:w-max"> <div class="flex flex-col border-l-4 border-garage-orange py-2 px-4 relative"> diff --git a/templates/index.html b/templates/index.html index 08cce9c..83adef7 100755 --- a/templates/index.html +++ b/templates/index.html @@ -7,25 +7,25 @@ <div class="flex flex-col items-center justify-center py-12 px-12 xl:px-0"> <img src="{{ config.extra.organization.logo }}" width="220px" class="" /> <p class="text-gray-500 leading-10 pt-4 text-xl text-center">{{ config.extra.organization.description }}</p> - <div class="max-w-7xl mx-auto grid-cols-1 md:grid grid-cols-3 gap-x-32 py-12"> + <div class="max-w-7xl mx-auto grid grid-cols-1 md:grid-cols-3 gap-x-32 py-12"> <div class="group flex flex-col items-start justify-center p-2"> - <img src="{{ get_url(path='images/host2.png') }}" class="transform group-hover:translate-y-4 transition duration-500"> - <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-2 transition duration-500">Host a Website</span> + <img src="{{ get_url(path='images/host2.png') }}" class="transform group-hover:translate-y-2 transition duration-500"> + <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-1 transition duration-500">Host a Website</span> </div> <div class="group flex flex-col items-center justify-center p-2"> - <img src="{{ get_url(path='images/store.png') }}" class="transform group-hover:translate-y-4 transition duration-500"> - <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-2 transition duration-500">Store Media</span> + <img src="{{ get_url(path='images/store.png') }}" class="transform group-hover:translate-y-2 transition duration-500"> + <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-1 transition duration-500">Store Media</span> </div> <div class="group flex flex-col items-end justify-center p-2"> - <img src="{{ get_url(path='images/backup.png') }}" class="transform group-hover:translate-y-4 transition duration-500"> - <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-2 transition duration-500">Backup Target</span> + <img src="{{ get_url(path='images/backup.png') }}" class="transform group-hover:translate-y-2 transition duration-500"> + <span class="text-xl text-gray-700 font-semibold mt-4 transform group-hover:-translate-y-1 transition duration-500">Backup Target</span> </div> </div> </div> <div class="grid grid-cols-1 xl:grid-cols-2 gap-x-0 xl:gap-x-12 gap-y-24 text-garage-gray font-light bg-gray-100 py-12 w-full shadow-inner"> - <div class="flex flex-col items-center justify-center space-y-2"> + <div class="flex flex-col items-center justify-start space-y-2"> <h2 class="mb-2 text-2xl font-bold text-garage-orange leading-5">Our Goals</h2> <div class="w-8 h-1 bg-garage-orange"></div> <p class="text-center leading-5 italic">We made it lightweight and kept the efficiency in mind.</p> @@ -58,7 +58,7 @@ </ul> </div> - <div class="flex flex-col items-center justify-center space-y-2"> + <div class="flex flex-col items-center justify-start space-y-2"> <h2 class="mb-2 text-2xl font-bold text-garage-orange leading-5">Keeping requirements low</h2> <div class="w-8 h-1 bg-garage-orange"></div> <p class="text-center leading-5 italic"> @@ -103,7 +103,7 @@ </ul> </div> - <div class="flex flex-col items-center justify-center space-y-2 px-6 xl:px-0"> + <div class="flex flex-col items-center justify-start space-y-2 px-6 xl:px-0"> <h2 class="mb-2 text-2xl font-bold text-garage-orange leading-5">Data resiliency for everyone</h2> <div class="w-8 h-1 bg-garage-orange"></div> <p class="text-center leading-5 italic pb-4"> @@ -146,8 +146,8 @@ </ul> </div> - <div class="flex flex-col items-center justify-center space-y-2 px-6 xl:px-0"> - <h2 class="mb-2 text-2xl font-bold text-garage-orange leading-5">Built on the shoulder of giants</h2> + <div class="flex flex-col items-center justify-start space-y-2 px-6 xl:px-0"> + <h2 class="mb-2 text-2xl font-bold text-garage-orange leading-5">Standing on the shoulders of giants</h2> <div class="w-8 h-1 bg-garage-orange"></div> <p class="text-center leading-5 italic"> Lorem ipsum dolor sit amet consectetur adipisicing elit. diff --git a/templates/partials/doc/global_toc.html b/templates/partials/doc/global_toc.html index ebad287..f739f49 100644 --- a/templates/partials/doc/global_toc.html +++ b/templates/partials/doc/global_toc.html @@ -1,8 +1,20 @@ -<aside id="global_toc" class="col-span-1 h-max bg-gray-100 shadow-inner border-r border-t border-gray-200"> +<aside id="global_toc" class="relative col-span-1 h-full bg-gray-100 shadow-inner border-r border-t border-gray-200"> {% if section.subsections %} - <ul class="space-y-2 py-0.5 px-6 py-3 list-none"> + <ul id="main-toc-menu" class="space-y-2 px-6 py-3 list-none"> + + {% if section.pages %} + {% for page in section.pages %} + <a + href="{{ page.permalink | safe }}" + class="docPage block pl-2 py-1 border-l rounded-r border-garage-orange hover:bg-garage-orange hover:bg-opacity-20 + {% if current_path == page.path %} activePage border-l-4 text-garage-orange font-semibold border-opacity-100 border-garage-orange {% endif %}"> + {{ page.title }} + </a> + {% endfor %} + {% endif %} + {% for subsec in section.subsections %} - {% set h1 = get_section(path=subsec) %} + {% set h1 = get_section(path=subsec) %} <li class="relative"> <a href="{{ h1.permalink | safe }}" diff --git a/templates/partials/doc/page_toc.html b/templates/partials/doc/page_toc.html index 172e0ce..238d8c3 100644 --- a/templates/partials/doc/page_toc.html +++ b/templates/partials/doc/page_toc.html @@ -1,12 +1,12 @@ -<aside class="hidden 2xl:block fixed right-0 bottom-1/2 transform translate-y-1/2 col-span-1 h-auto bg-gray-100 rounded-l-lg shadow-inner"> +<aside class="hidden 2xl:block fixed right-0 bottom-1/2 transform translate-y-1/2 w-80 col-span-1 h-auto bg-gray-100 rounded-l-lg shadow-inner"> {% if page.toc %} <div class="w-full flex items-center justify-center py-1.5 bg-gray-200 rounded-tl-lg"> <span class="uppercase tracking-wide text-xs text-garage-gray">Page content</span> </div> - <ol class="text-sm space-y-0.5 py-0.5 px-8 py-3 list-decimal"> + <ol class="text-sm space-y-0.5 px-8 py-3 list-decimal"> {% for h1 in page.toc %} <li> - <a href="{{ h1.permalink | safe }}" class="font-semibold bg-gradient-to-r from-garage-gray to-garage-orange text-transparent bg-clip-text transition-all hover:text-garage-orange">{{ h1.title }}</a> + <a href="{{ h1.permalink | safe }}" class="font-semibold text-gray-800 transition-all hover:text-garage-orange">{{ h1.title }}</a> {% if h1.children %} <ul class="space-y-0.5 py-0.5"> {% for h2 in h1.children %} diff --git a/templates/partials/doc/toc_script.html b/templates/partials/doc/toc_script.html index a858c94..df115b0 100644 --- a/templates/partials/doc/toc_script.html +++ b/templates/partials/doc/toc_script.html @@ -1,9 +1,29 @@ -<script type="text/javascript"> +<script> const menuBarHeight = document.querySelector("nav.navbar").clientHeight; +const mainTocMenuWidth = document.getElementById('main-toc-menu').clientWidth; const tocItems = document.querySelectorAll(".toc"); const navSections = new Array(tocItems.length); + // Global ToC +/* + Fixed ToC when user scrolls. +*/ + +window.addEventListener('scroll', function() { + if (window.scrollY >= menuBarHeight) { + document.getElementById('main-toc-menu').classList.add('fixed', 'top-0', 'left-0'); + document.getElementById('main-toc-menu').style.width = mainTocMenuWidth + 'px'; + } else { + document.getElementById('main-toc-menu').classList.remove('fixed', 'top-0', 'left-0'); + } +}); + +// Page content +/* + Focus effect on current section anchor when user scrolls. +*/ + tocItems.forEach((el, i) => { let id = el.getAttribute("id").substring(5); navSections[i] = document.getElementById(id); @@ -42,7 +62,6 @@ window.addEventListener('scroll', () => { } }, false); -// If JS enabled, deploy only the current doc menu document.addEventListener("DOMContentLoaded", function() { var menusTriggers = document.getElementsByClassName("deploySubMenu"); var activeDocPage = document.getElementsByClassName("activePage")[0]; diff --git a/templates/partials/shared/nav.html b/templates/partials/shared/nav.html index 2489bf6..af46f2a 100644 --- a/templates/partials/shared/nav.html +++ b/templates/partials/shared/nav.html @@ -1,17 +1,17 @@ <nav aria-label="section navigation" class="navbar w-full" role="navigation"> - <div class="w-full flex flex-col space-y-2 md:space-y-0 md:flex-row items-center justify-between py-1 px-8 text-garage-gray bg-garage-orange bg-opacity-20"> + <div class="w-full flex flex-col space-y-2 md:space-y-0 md:flex-row items-center justify-between py-1.5 px-8 text-garage-gray bg-garage-orange bg-opacity-20"> <div class="navbar-brand"> <a class="hover:rounded-full hover:bg-white" href="{{config.base_url}}"> - <img class="transform duration-150 focus:bg-white hover:bg-white hover:shadow rounded-lg hover:scale-90" - src="{{ config.extra.organization.logo }}" width="65px"> + <img class="px-2 transform duration-150 focus:bg-white hover:bg-white hover:shadow rounded-lg" + src="{{ config.extra.organization.logo_horizontal }}" width="120px"> </a> </div> <div class="navbar-menu" id="navMenu"> - <div class="flex items-center justify-center"> + <div class="flex items-center justify-center space-x-2"> {% for item in config.extra.navbar_items %} {% if lang == item.code %} {% for nav in item.nav_items %} - <a class="font-semibold focus:bg-white hover:bg-white hover:shadow px-4 py-2 rounded-lg" + <a class="font-semibold focus:bg-white hover:bg-white hover:shadow px-3 py-1 rounded-lg" href="{{ nav.url | replace(from='$BASE_URL', to=config.base_url) }}"> {{ nav.name }} </a> @@ -25,6 +25,12 @@ class="focus:bg-white hover:bg-white hover:shadow px-4 py-2 rounded-lg"> <svg id="nav-search-btn-icon" class="w-5 h-5" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"></path></svg> </button> + <a + href="https://garagehq.deuxfleurs.fr/_releases.html" + class="group flex items-center justify-center space-x-1 font-semibold shadow hover:bg-white hover:shadow px-2 py-1.5 rounded bg-orange-400 text-white hover:text-orange-400"> + <svg class="w-6 h-6 animate-pulse group-hover:animate-bounce" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7 16a4 4 0 01-.88-7.903A5 5 0 1115.9 6L16 6a5 5 0 011 9.9M9 19l3 3m0 0l3-3m-3 3V10"></path></svg> + <span>Download</span> + </a> </div> </div> </div> |