Skip to content

Commit

Permalink
Merge branch 'dev' into dawn/style-faucets-page
Browse files Browse the repository at this point in the history
  • Loading branch information
dawnkelly09 committed Sep 17, 2024
2 parents fdb4e7d + d9078f5 commit bb7a240
Show file tree
Hide file tree
Showing 7 changed files with 109 additions and 8 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
venv
.DS_Store
wormhole-docs
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "wormhole-docs"]
path = wormhole-docs
url = https://github.com/wormhole-foundation/wormhole-docs
24 changes: 24 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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:
Expand Down
9 changes: 7 additions & 2 deletions material-overrides/assets/stylesheets/home.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -43,7 +43,7 @@ h3 {

.hero p {
font-size: var(--body-l-size);
margin: 3em 0 3.5em;
margin: 4em 0 6em;
}

.button-wrapper {
Expand Down Expand Up @@ -187,6 +187,11 @@ h3 {
margin-top: -5em;
}

.hero p {
font-size: var(--body-l-size);
margin: 3em 0;
}

.feature p {
min-height: 7em;
}
Expand Down
71 changes: 70 additions & 1 deletion material-overrides/assets/stylesheets/wormhole.css
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -956,6 +965,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,
Expand All @@ -978,11 +989,21 @@ pre .md-clipboard {
text-align: center;
}

.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;
Expand Down Expand Up @@ -1283,4 +1304,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;
}
1 change: 1 addition & 0 deletions wormhole-docs
Submodule wormhole-docs added at e551c0

0 comments on commit bb7a240

Please sign in to comment.