adam/leptos-use
1
0
Fork 0
mirror of https://github.com/adoyle0/leptos-use.git synced 2025-01-22 16:49:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc cosmetics

Browse source
This commit is contained in:
Maccesch 2023-05-31 00:00:41 +01:00
parent 715f858ea2
commit ef35c87e88
9 changed files with 178 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,13 +1,10 @@
<p align="center">
<a href="https://github.com/synphonyte/leptos-use#gh-light-mode-only">
<img src="https://raw.githubusercontent.com/synphonyte/leptos-use/main/docs/logo-light.svg#gh-light-mode-only" alt="Leptos-Use – Collection of essential Leptos utilities" width="130"/>
</a>
<a href="https://github.com/synphonyte/leptos-use#gh-dark-mode-only">
<img src="https://raw.githubusercontent.com/synphonyte/leptos-use/main/docs/logo-dark.svg#gh-dark-mode-only" alt="Leptos-Use – Collection of essential Leptos utilities" width="130"/>
<a href="https://github.com/synphonyte/leptos-use">
<img src="https://raw.githubusercontent.com/synphonyte/leptos-use/main/docs/logo.svg" alt="Leptos-Use – Collection of essential Leptos utilities" width="130"/>
</a>
</p>
<h1 align="center">Leptos-Use</h1>
<h1 align="center" style="font-weight: normal">Leptos-Use</h1>
<p align="center"> Collection of essential Leptos utilities inspired by SolidJS-USE / VueUse</p>

2
docs/book/book.toml
View file

@ -8,5 +8,7 @@ title = "Leptos-Use Documentation"
[output.html]
no-section-label = true
additional-css = ["src/custom.css", "src/demo.css"]
preferred-dark-theme = "coal"
git-repository-url = "https://github.com/synphonyte/leptos-use"
[preprocessor.cmdrun]

43
docs/book/src/custom.css
View file

@ -28,9 +28,50 @@ pre > code {
grid-template-columns: 70px auto;
gap: 2rem;
align-items: flex-start;
margin: 2rem 0 4rem;
margin: 2rem 0 4rem;
}
.meta-data > div:first-child {
opacity: 0.5;
}
.sidebar .sidebar-scrollbox {
padding: 10px 10px 10px 20px ;
}
.chapter li.chapter-item {
margin: 0;
}
.chapter li.part-title {
margin-top: 20px;
}
li.chapter-item a {
padding: 0.1em 1em;
margin: 0.4em 0 0;
}
li.chapter-item::before {
content: " ";
border-left: 1px solid var(--fg);
opacity: 0.1;
}
li.chapter-item a.active {
border-left: 1px solid currentColor;
font-weight: 600;
margin-left: -1px;
}
li.part-title + li.chapter-item a {
margin-top: 0;
}
li.chapter-item.affix::before {
content: none;
}
li.chapter-item.affix a {
padding-left: 0;
}

BIN
docs/book/theme/favicon.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.6 KiB

27
docs/book/theme/favicon.svg Normal file
View file

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 32 32" version="1.1" xmlns="http://www.w3.org/2000/svg"
style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<style>
path.black {
fill: #1e1838;
}
@media (prefers-color-scheme: dark) {
path.black {
fill: white;
}
}
</style>
<path d="M16.114,22.343c-1.714,-0 -3.2,-0.914 -3.885,-2.514c-0.458,-1.029 -0.572,-2.172 -0.229,-3.315c0.343,-1.143 1.143,-1.943 2.171,-2.514c0.572,-0.343 1.258,-0.457 1.829,-0.457c1.714,-0 3.2,0.914 3.886,2.514c1.028,2.172 0.114,4.8 -2.057,5.829c-0.458,0.228 -1.029,0.457 -1.715,0.457Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M16.114,15.943c0.572,-0 1.486,0.343 1.829,1.143c0.343,0.685 0.228,1.257 0.114,1.6c-0.114,0.343 -0.343,0.8 -1.028,1.143c-0.229,0.114 -0.572,0.228 -0.915,0.228c-0.571,0 -1.485,-0.343 -1.828,-1.143c-0.457,-1.028 -0.115,-2.285 0.914,-2.743c0.343,-0.228 0.571,-0.228 0.914,-0.228Zm0,-4.572c-0.914,0 -1.943,0.229 -2.857,0.686c-3.314,1.486 -4.686,5.486 -3.086,8.8c1.143,2.4 3.543,3.772 5.943,3.772c0.915,-0 1.943,-0.229 2.857,-0.686c3.315,-1.6 4.686,-5.6 3.086,-8.8c-1.143,-2.4 -3.428,-3.772 -5.943,-3.772Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M16.114,6.114c-0.8,0 -1.485,-0.457 -1.828,-1.143c-0.457,-1.028 -0,-2.171 0.914,-2.628c0.229,-0.114 0.571,-0.229 0.914,-0.229c0.8,0 1.486,0.457 1.829,1.143c0.457,1.029 0.114,2.172 -0.914,2.629c-0.343,0.114 -0.572,0.228 -0.915,0.228Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M16.114,3.829c0,-0 0.229,-0 0.229,0.114c0.114,0.114 -0,0.343 -0.114,0.343l-0.115,-0c0,-0 -0.228,-0 -0.228,-0.115c-0.115,-0.114 -0,-0.342 0.114,-0.342l0.114,-0Zm0,-3.429c-0.571,-0 -1.143,0.114 -1.6,0.343c-1.828,0.914 -2.628,3.086 -1.714,5.028c0.686,1.372 1.943,2.058 3.314,2.058c0.572,-0 1.143,-0.115 1.6,-0.343c1.829,-0.915 2.629,-3.086 1.715,-4.915c-0.572,-1.371 -1.943,-2.171 -3.315,-2.171Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path class="black"
d="M27.314,10.914c0,-0.114 -0.114,-0.343 -0.343,-0.571c0,-0.114 -0.114,-0.229 -0.114,-0.229c-0.457,-0.8 -1.143,-1.943 -1.143,-1.943l-2.514,1.486l1.486,2.629c1.943,3.657 2.057,7.657 0.571,10.857c-1.6,3.428 -5.028,5.371 -9.143,5.371c-4.228,0 -7.543,-1.943 -9.143,-5.371c-1.6,-3.2 -1.371,-7.2 0.572,-10.857l1.6,-2.629l-2.743,-1.486c-0,0 -0.686,1.029 -1.143,1.943c-0.114,0 -0.228,0.115 -0.228,0.229c-0.115,0.228 -0.229,0.457 -0.343,0.571c-2.286,4.572 -2.515,9.486 -0.457,13.715c2.171,4.457 6.4,6.971 11.771,6.971c5.257,0 9.6,-2.514 11.771,-6.971c2.058,-4.229 1.829,-9.258 -0.457,-13.715Z"
style="fill-rule:nonzero;"/>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 2.8 KiB

76
docs/book/theme/header.hbs Normal file
View file

@ -0,0 +1,76 @@
<div id="header-logo-container">
<span id="header-logo-title-placeholder">
<svg id="header-logo" height="28" viewBox="0 0 74 88" xmlns="http://www.w3.org/2000/svg"
style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<style>
path.black {
fill: #1e1838;
}
.ayu path.black, .coal path.black, .navy path.black {
fill: white;
}
</style>
<rect x="34.158" y="17.9" width="5.7" height="16.1" style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M37.058,70.7c-7.6,-0 -14.7,-4.4 -18,-11.3c-2.3,-4.8 -2.6,-10.2 -0.8,-15.3c1.8,-5 5.4,-9.1 10.2,-11.4c2.7,-1.3 5.6,-2 8.6,-2c7.6,-0 14.7,4.4 18,11.3c2.3,4.8 2.6,10.2 0.8,15.3c-1.8,5 -5.4,9.1 -10.2,11.4c-2.7,1.4 -5.6,2 -8.6,2Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M36.958,32.8c6.9,0 13.2,4 16.2,10.2c2.1,4.3 2.4,9.2 0.8,13.7c-1.6,4.5 -4.8,8.2 -9.2,10.3c-2.5,1.2 -5.1,1.8 -7.8,1.8c-6.9,0 -13.2,-4 -16.2,-10.2c-4.3,-8.9 -0.5,-19.7 8.4,-24c2.5,-1.2 5.1,-1.8 7.8,-1.8Zm-0,-4c-3.2,0 -6.4,0.7 -9.5,2.2c-10.9,5.3 -15.5,18.4 -10.3,29.3c3.8,7.9 11.6,12.5 19.8,12.5c3.2,0 6.4,-0.7 9.5,-2.2c10.9,-5.3 15.5,-18.4 10.3,-29.3c-3.7,-8 -11.6,-12.5 -19.8,-12.5Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M37.058,19.9c-3.4,-0 -6.6,-2 -8.1,-5.1c-2.1,-4.5 -0.3,-9.9 4.2,-12c1.2,-0.6 2.5,-0.9 3.9,-0.9c3.4,-0 6.6,2 8.1,5.1c1,2.2 1.2,4.6 0.4,6.9c-0.8,2.3 -2.4,4.1 -4.6,5.1c-1.3,0.6 -2.6,0.9 -3.9,0.9Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M36.958,3.4c2.9,-0 5.5,1.7 6.8,4.3c1.8,3.7 0.2,8.2 -3.5,10c-1,0.5 -2.1,0.7 -3.2,0.7c-2.9,0 -5.5,-1.7 -6.8,-4.3c-1.8,-3.7 -0.2,-8.2 3.5,-10c1,-0.4 2.1,-0.7 3.2,-0.7Zm-0,-3c-1.5,0 -3.1,0.3 -4.5,1c-5.2,2.5 -7.4,8.8 -4.9,14c1.8,3.8 5.6,6 9.5,6c1.5,0 3.1,-0.3 4.5,-1c5.2,-2.5 7.4,-8.8 4.9,-14c-1.8,-3.8 -5.6,-6 -9.5,-6Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path class="black"
d="M68.458,29.9c-0.1,-0.3 -0.4,-0.9 -0.8,-1.6c-0.1,-0.3 -0.3,-0.5 -0.4,-0.8c-1.4,-2.3 -3.2,-5.4 -3.2,-5.4l-7.1,4.1l4.3,7.4c5.3,10.1 5.9,21.2 1.5,30.2c-4.8,9.6 -14.1,15 -25.8,15c-11.6,0 -20.9,-5.4 -25.5,-14.8c-4.4,-9 -3.8,-20.1 1.4,-30.2l4.3,-7.5l-7.1,-4.1c-0,0 -1.9,3 -3.2,5.3c-0.1,0.3 -0.3,0.6 -0.5,0.9c-0.4,0.6 -0.6,1.2 -0.8,1.5c-6.4,12.6 -7,26.6 -1.3,38.2c6,12.3 17.9,19.4 32.6,19.5l0.2,0c14.7,-0.1 26.6,-7.2 32.6,-19.5c5.8,-11.6 5.2,-25.5 -1.2,-38.2Z"
style="fill-rule:nonzero;"/>
</svg>
{{ book_title }}
</span>
</div>
<style>
:root {
--open-sidebar-width: 0px;
}
.sidebar-visible {
--open-sidebar-width: var(--sidebar-width);
}
#header-logo-container {
text-align: center;
position: fixed;
z-index: 102;
top: 0;
left: calc(113px + var(--open-sidebar-width));
width: calc(100% - var(--open-sidebar-width) - 113px - 65px);
height: var(--menu-bar-height);
transition: all 0.3s;
}
#header-logo {
position: absolute;
left: -35px;
top: 2px;
}
#header-logo-title-placeholder {
font-weight: 200;
font-size: 2.4rem;
line-height: var(--menu-bar-height);
position: relative;
color: rgba(0, 0, 0, 0);
}
@media screen and (max-width: 900px) {
.sidebar-visible #header-logo {
display: none;
}
}
@media screen and (max-width: 600px) {
.sidebar-hidden #header-logo {
display: none;
}
}
</style>

1
docs/logo-dark.svg
View file

@ -1 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 168 217" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><path d="M131.257,94.658c-6.632,-8.226 -15.339,-14.714 -25.318,-18.662c3.633,-8.732 8.625,-16.755 14.698,-23.826c1.911,0.841 3.915,1.5 5.988,1.985c1.511,0.353 3.056,0.617 4.632,0.772l0,39.731Zm-24.2,-94.658c-2.206,2.905 -3.96,6.171 -5.158,9.691c-0.805,2.366 -1.359,4.847 -1.629,7.412c-0.126,1.192 -0.191,2.403 -0.191,3.628c0,9.111 3.589,17.381 9.397,23.536c-7,8.355 -12.68,17.842 -16.757,28.136c-3.035,-0.463 -6.141,-0.704 -9.302,-0.704c-19.289,-0 -36.529,8.938 -47.797,22.889l0,-94.588l71.437,-0Z" style="fill:#555;"/><path d="M35.62,133.116c0,-26.355 21.442,-47.797 47.797,-47.797c26.355,-0 47.796,21.442 47.796,47.797c0,26.355 -21.441,47.796 -47.796,47.796c-26.355,-0 -47.797,-21.441 -47.797,-47.796Zm98.812,-133.116c1.233,0 2.434,0.128 3.609,0.335c9.714,1.716 17.123,10.198 17.123,20.396c0,11.432 -9.3,20.733 -20.732,20.733c-11.433,0 -20.733,-9.301 -20.733,-20.733c0,-2.67 0.525,-5.215 1.448,-7.561c3.031,-7.698 10.523,-13.17 19.285,-13.17Z" style="fill:#ee383a;"/><path d="M0,133.191l0,-133.191l22,0l0,133.191l0.011,0c0,33.967 27.536,61.503 61.503,61.503c33.729,0 60.976,-27.151 61.359,-60.79c0.002,-0.237 0.004,-0.475 0.004,-0.713l0,-79.73c10.419,-3.333 18.691,-11.513 22.15,-21.876l0,101.606c0,46.124 -37.39,83.514 -83.513,83.514c-46.124,0 -83.514,-37.39 -83.514,-83.514Z" style="fill:#dbdbdb;"/></svg>
Side by side

Before

Width:  |  Height:  |  Size: 1.7 KiB

1
docs/logo-light.svg
View file

@ -1 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 168 217" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><path d="M131.257,94.658c-6.632,-8.226 -15.339,-14.714 -25.318,-18.662c3.633,-8.732 8.625,-16.755 14.698,-23.826c1.911,0.841 3.915,1.5 5.988,1.985c1.511,0.353 3.056,0.617 4.632,0.772l-0,39.731Zm-24.2,-94.658c-2.206,2.905 -3.96,6.171 -5.158,9.691c-0.805,2.366 -1.359,4.847 -1.629,7.412c-0.126,1.192 -0.191,2.403 -0.191,3.628c0,9.111 3.589,17.381 9.397,23.536c-7,8.355 -12.68,17.842 -16.757,28.136c-3.035,-0.463 -6.141,-0.704 -9.302,-0.704c-19.289,-0 -36.529,8.938 -47.797,22.889l-0,-94.588l71.437,-0Z" style="fill:#bdbdbd;"/><path d="M35.62,133.116c-0,-26.355 21.442,-47.797 47.797,-47.797c26.355,-0 47.796,21.442 47.796,47.797c0,26.355 -21.441,47.796 -47.796,47.796c-26.355,0 -47.797,-21.441 -47.797,-47.796Zm98.812,-133.116c1.233,0 2.434,0.128 3.609,0.335c9.714,1.716 17.123,10.198 17.123,20.396c-0,11.432 -9.3,20.733 -20.732,20.733c-11.433,-0 -20.733,-9.301 -20.733,-20.733c0,-2.67 0.525,-5.215 1.448,-7.561c3.031,-7.698 10.523,-13.17 19.285,-13.17Z" style="fill:#ee383a;"/><path d="M0,133.191l0,-133.191l22,0l0,133.191l0.011,0c-0,33.967 27.536,61.503 61.503,61.503c33.729,0 60.976,-27.151 61.359,-60.79c0.002,-0.237 0.004,-0.475 0.004,-0.713l-0,-79.73c10.419,-3.333 18.691,-11.513 22.15,-21.876l0,101.606c0,46.124 -37.39,83.514 -83.513,83.514c-46.124,-0 -83.514,-37.39 -83.514,-83.514Z"/></svg>
Side by side

Before

Width:  |  Height:  |  Size: 1.7 KiB

28
docs/logo.svg Normal file
View file

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 74 88" version="1.1" xmlns="http://www.w3.org/2000/svg"
style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<style>
path.black {
fill: #1e1838;
}
@media (prefers-color-scheme: dark) {
path.black {
fill: white;
}
}
</style>
<rect x="34.158" y="17.9" width="5.7" height="16.1" style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M37.058,70.7c-7.6,-0 -14.7,-4.4 -18,-11.3c-2.3,-4.8 -2.6,-10.2 -0.8,-15.3c1.8,-5 5.4,-9.1 10.2,-11.4c2.7,-1.3 5.6,-2 8.6,-2c7.6,-0 14.7,4.4 18,11.3c2.3,4.8 2.6,10.2 0.8,15.3c-1.8,5 -5.4,9.1 -10.2,11.4c-2.7,1.4 -5.6,2 -8.6,2Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M36.958,32.8c6.9,0 13.2,4 16.2,10.2c2.1,4.3 2.4,9.2 0.8,13.7c-1.6,4.5 -4.8,8.2 -9.2,10.3c-2.5,1.2 -5.1,1.8 -7.8,1.8c-6.9,0 -13.2,-4 -16.2,-10.2c-4.3,-8.9 -0.5,-19.7 8.4,-24c2.5,-1.2 5.1,-1.8 7.8,-1.8Zm-0,-4c-3.2,0 -6.4,0.7 -9.5,2.2c-10.9,5.3 -15.5,18.4 -10.3,29.3c3.8,7.9 11.6,12.5 19.8,12.5c3.2,0 6.4,-0.7 9.5,-2.2c10.9,-5.3 15.5,-18.4 10.3,-29.3c-3.7,-8 -11.6,-12.5 -19.8,-12.5Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M37.058,19.9c-3.4,-0 -6.6,-2 -8.1,-5.1c-2.1,-4.5 -0.3,-9.9 4.2,-12c1.2,-0.6 2.5,-0.9 3.9,-0.9c3.4,-0 6.6,2 8.1,5.1c1,2.2 1.2,4.6 0.4,6.9c-0.8,2.3 -2.4,4.1 -4.6,5.1c-1.3,0.6 -2.6,0.9 -3.9,0.9Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path d="M36.958,3.4c2.9,-0 5.5,1.7 6.8,4.3c1.8,3.7 0.2,8.2 -3.5,10c-1,0.5 -2.1,0.7 -3.2,0.7c-2.9,0 -5.5,-1.7 -6.8,-4.3c-1.8,-3.7 -0.2,-8.2 3.5,-10c1,-0.4 2.1,-0.7 3.2,-0.7Zm-0,-3c-1.5,0 -3.1,0.3 -4.5,1c-5.2,2.5 -7.4,8.8 -4.9,14c1.8,3.8 5.6,6 9.5,6c1.5,0 3.1,-0.3 4.5,-1c5.2,-2.5 7.4,-8.8 4.9,-14c-1.8,-3.8 -5.6,-6 -9.5,-6Z"
style="fill:#e1393a;fill-rule:nonzero;"/>
<path class="black"
d="M68.458,29.9c-0.1,-0.3 -0.4,-0.9 -0.8,-1.6c-0.1,-0.3 -0.3,-0.5 -0.4,-0.8c-1.4,-2.3 -3.2,-5.4 -3.2,-5.4l-7.1,4.1l4.3,7.4c5.3,10.1 5.9,21.2 1.5,30.2c-4.8,9.6 -14.1,15 -25.8,15c-11.6,0 -20.9,-5.4 -25.5,-14.8c-4.4,-9 -3.8,-20.1 1.4,-30.2l4.3,-7.5l-7.1,-4.1c-0,0 -1.9,3 -3.2,5.3c-0.1,0.3 -0.3,0.6 -0.5,0.9c-0.4,0.6 -0.6,1.2 -0.8,1.5c-6.4,12.6 -7,26.6 -1.3,38.2c6,12.3 17.9,19.4 32.6,19.5l0.2,0c14.7,-0.1 26.6,-7.2 32.6,-19.5c5.8,-11.6 5.2,-25.5 -1.2,-38.2Z"
style="fill-rule:nonzero;"/>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 2.5 KiB