From 063d9219fada691f2de3b5e07d579e32b0396914 Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Wed, 11 Sep 2024 05:16:06 -0400 Subject: [PATCH 01/11] Eshaben/styling feedback (#10) * fix spacing of elements on home page * fix spacing of icons and text on cards * push CTAs down to the bottom of the cards --- material-overrides/assets/stylesheets/home.css | 9 +++++++-- material-overrides/assets/stylesheets/wormhole.css | 12 ++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/material-overrides/assets/stylesheets/home.css b/material-overrides/assets/stylesheets/home.css index daec7645..d425388d 100644 --- a/material-overrides/assets/stylesheets/home.css +++ b/material-overrides/assets/stylesheets/home.css @@ -12,7 +12,7 @@ h3 { .hero { display: flex; text-align: left; - padding: 0 0 1em 0; + padding: 0; align-items: center; min-height: 50em; margin-top: -8em; @@ -43,7 +43,7 @@ h3 { .hero p { font-size: var(--body-l-size); - margin: 3em 0 3.5em; + margin: 4em 0 6em; } .button-wrapper { @@ -187,6 +187,11 @@ h3 { margin-top: -5em; } + .hero p { + font-size: var(--body-l-size); + margin: 3em 0; + } + .feature p { min-height: 7em; } diff --git a/material-overrides/assets/stylesheets/wormhole.css b/material-overrides/assets/stylesheets/wormhole.css index 4d517243..7e982557 100644 --- a/material-overrides/assets/stylesheets/wormhole.css +++ b/material-overrides/assets/stylesheets/wormhole.css @@ -956,6 +956,8 @@ pre .md-clipboard { .md-typeset .grid>.card { background-color: var(--grey); border: var(--md-border-width) solid var(--md-border-color); + display: flex; + flex-direction: column; } .md-typeset .grid.cards>ol>li:focus-within, @@ -967,11 +969,21 @@ pre .md-clipboard { border: var(--md-border-width) solid var(--md-border-color); } +.md-typeset .grid.cards>ol>li>:last-child, +.md-typeset .grid.cards>ul>li>:last-child, +.md-typeset .grid>.card>:last-child { + margin-top: auto; +} + .md-typeset .grid.half { grid-template-columns: repeat(auto-fit, minmax(50%, 0fr)); margin: 1em 1.4em 1em 0; } +.md-typeset .grid.cards .twemoji.lg.middle svg { + margin-right: .5em; +} + /* Type styling */ .md-typeset kbd { border-radius: 1em; From e308f98edfd6f48e3d021e6782e09a0a6bbd1298 Mon Sep 17 00:00:00 2001 From: albertov19 Date: Wed, 11 Sep 2024 14:22:41 +0200 Subject: [PATCH 02/11] added submodule --- .gitignore | 1 - .gitmodules | 3 +++ wormhole-docs | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 wormhole-docs diff --git a/.gitignore b/.gitignore index 21359f93..d09d9783 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ venv .DS_Store -wormhole-docs \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..54469029 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "wormhole-docs"] + path = wormhole-docs + url = https://github.com/wormhole-foundation/wormhole-docs diff --git a/wormhole-docs b/wormhole-docs new file mode 160000 index 00000000..e09f4e1a --- /dev/null +++ b/wormhole-docs @@ -0,0 +1 @@ +Subproject commit e09f4e1aea002516e7efd7c31879e54f7180fd1e From bf1cf8a2ccf5222e417387280ce8d32247f1a2bc Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:49:27 +0200 Subject: [PATCH 03/11] added submodule (#12) (#13) From 4bd308d30be40ea8349e761e90c5ae266c4e3ddd Mon Sep 17 00:00:00 2001 From: albertov19 Date: Wed, 11 Sep 2024 15:19:43 +0200 Subject: [PATCH 04/11] Update wormhole-docs --- wormhole-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wormhole-docs b/wormhole-docs index e09f4e1a..45ed24ee 160000 --- a/wormhole-docs +++ b/wormhole-docs @@ -1 +1 @@ -Subproject commit e09f4e1aea002516e7efd7c31879e54f7180fd1e +Subproject commit 45ed24ee34544ae6d9dda44a5f1348cb9181611a From a36572c36a2bfc30937bd0cea1a60beb1e86389d Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Wed, 11 Sep 2024 15:50:28 +0200 Subject: [PATCH 05/11] added submodule (#12) (#17) From 5bf71e65df1df1737a7cfac0d1a43b73801a4a18 Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Wed, 11 Sep 2024 16:18:35 +0200 Subject: [PATCH 06/11] Update instructions (#14) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ade7f6b8..38da701c 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,12 @@ pip install -r requirements.txt ## Getting Started -With the dependencies installed, you can proceed to clone the necessary repos. For everything to work correctly, the file structure needs to be as follows: +For everything to work correctly, the file structure needs to be as follows: ```text wormhole-mkdocs |--- /material-overrides/ (folder) -|--- /wormhole-docs/ (repository) +|--- /wormhole-docs/ (submodule) |--- mkdocs.yml ``` @@ -36,11 +36,11 @@ To set up the structure, follow these steps: git clone https://github.com/papermoonio/wormhole-mkdocs ``` -2. Inside the folder just created, clone the [wormhole-docs repository](https://github.com/wormhole-foundation/wormhole-docs): +2. Inside the folder just created, initialize and update the [wormhole-docs repository](https://github.com/wormhole-foundation/wormhole-docs): ```bash cd wormhole-mkdocs - git clone https://github.com/wormhole-foundation/wormhole-docs.git + git submodule init && git submodule update ``` 3. In the `wormhole-mkdocs` folder (which should be the current one), you can build the site by running: From 3736cc1846e7eb716bb295c5ae8725e75f25f5b0 Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Wed, 11 Sep 2024 18:27:19 +0200 Subject: [PATCH 07/11] update dev to 2a4cf4 (#19) --- wormhole-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wormhole-docs b/wormhole-docs index 45ed24ee..2a4cf4c4 160000 --- a/wormhole-docs +++ b/wormhole-docs @@ -1 +1 @@ -Subproject commit 45ed24ee34544ae6d9dda44a5f1348cb9181611a +Subproject commit 2a4cf4c40cb0f7ac7bdf00ab1d69f9c61c9b1d84 From 75bf187f43bb1ce50fc17de0e5d552334baadd3f Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Wed, 11 Sep 2024 22:26:01 +0200 Subject: [PATCH 08/11] update dev to d30a0c (#21) --- wormhole-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wormhole-docs b/wormhole-docs index 2a4cf4c4..d30a0c85 160000 --- a/wormhole-docs +++ b/wormhole-docs @@ -1 +1 @@ -Subproject commit 2a4cf4c40cb0f7ac7bdf00ab1d69f9c61c9b1d84 +Subproject commit d30a0c85c8a06de1f56c8a15941fffe48865c2be From ea194aa8863032d3e50d0ef21d49431ee71b266a Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Wed, 11 Sep 2024 20:36:21 -0400 Subject: [PATCH 09/11] add interface and child admonition styling (#15) --- .../assets/stylesheets/wormhole.css | 59 ++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/material-overrides/assets/stylesheets/wormhole.css b/material-overrides/assets/stylesheets/wormhole.css index 7e982557..3ac805cd 100644 --- a/material-overrides/assets/stylesheets/wormhole.css +++ b/material-overrides/assets/stylesheets/wormhole.css @@ -14,8 +14,10 @@ --light-transparent-90: rgba(255, 255, 255, 0.9); --light-transparent-60: rgba(255, 255, 255, 0.6); --light-transparent-40: rgba(255, 255, 255, 0.4); + --light-transparent-20: rgba(255, 255, 255, 0.2); --light-transparent-12: rgba(255, 255, 255, 0.12); --light-transparent-10: rgba(255, 255, 255, 0.1); + --light-transparent-07: rgba(255, 255, 255, 0.07); --plum: #c1bbf6; --plum-transparent-70: rgba(193, 187, 246, 0.7); --plum-transparent-50: rgba(193, 187, 246, 0.5); @@ -686,10 +688,17 @@ pre .md-clipboard { .md-typeset .tabbed-block p, .md-typeset .tabbed-block ul, -.md-typeset .tabbed-block ol { +.md-typeset .tabbed-block ol, +.md-typeset .tabbed-block p~div, +.md-typeset .tabbed-block details { margin: 1em; } +.md-typeset .tabbed-block ul p, +.md-typeset .tabbed-block ol p { + margin: 0; +} + /* Document date styling */ .md-source-file small { display: flex; @@ -1284,4 +1293,52 @@ label[for='__search']:hover { /* Cookie consent styling */ .md-consent__inner { box-shadow: 0 0 .2rem #ffffff1a,0 .2rem .4rem #fff3; +} + +/* Interface admonition styling */ +details.interface>summary::before { + display: none; +} + +.md-typeset details.interface { + border: 1px solid var(--light-transparent-20); + box-shadow: none; + width: auto; +} + +[dir=ltr] .md-typeset details.interface>summary { + padding: 1em 0 1em 1em; + background-color: var(--light-transparent-07); +} + +.md-typeset details.interface>summary:after { + top: auto; +} + +/* Child admonition styling */ +details.child summary::before { + display: none; +} + +details.child { + width: fit-content; +} + +[dir=ltr] .md-typeset details.child summary { + width: fit-content; + padding-left: 1em; +} + +[dir=ltr] .md-typeset details.child[open] { + width: auto; +} + +.md-typeset details.child summary { + background-color: unset; +} + +.md-typeset details.child { + width: fit-content; + border: 1px solid var(--light-transparent-20); + box-shadow: none; } \ No newline at end of file From a01112ee75c188682967f8366cd38155b8a687b4 Mon Sep 17 00:00:00 2001 From: albertov19 <64150856+albertov19@users.noreply.github.com> Date: Fri, 13 Sep 2024 15:20:05 +0200 Subject: [PATCH 10/11] Create LICENSE (#23) --- LICENSE | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..7f31ce1c --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +BSD 2-Clause License + +Copyright (c) 2024, PaperMoon DEV SL + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. From d9078f58ceb1ff6e34412b35a8624fc7bcd3ab00 Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Mon, 16 Sep 2024 12:07:32 -0400 Subject: [PATCH 11/11] publish e551c0 (#26) --- wormhole-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wormhole-docs b/wormhole-docs index d30a0c85..e551c036 160000 --- a/wormhole-docs +++ b/wormhole-docs @@ -1 +1 @@ -Subproject commit d30a0c85c8a06de1f56c8a15941fffe48865c2be +Subproject commit e551c0366e143c4c2bed7afea1898a9746e73fbc