Skip to content

Commit cdaed08

Browse files
committed
add swarm-cli optionally to prereqs and add css to make links in admonitions more noticable
1 parent fc55f21 commit cdaed08

File tree

2 files changed

+74
-11
lines changed

2 files changed

+74
-11
lines changed

docs/documentation/getting-started.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ On this page you will learn how to install `bee-js` and connect it with your exi
2424
- **Linux or macOS:** A Unix based operating system is preferred. Windows is supported with some small exceptions. For a smoother experience, Windows users can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
2525
- **Node.js (v18 or higher)** - [Get Node.js](https://nodejs.org/)
2626
- **npm (Node Package Manager)** - [Get npm](https://docs.npmjs.com/)
27+
- **`swarm-cli`** (optional cli tool for command line node management) - [Get `swarm-cli`](https://github.com/ethersphere/swarm-cli/blob/master/README.md)
2728

2829
:::tip
2930
Node.js and npm are not required if you choose to import `bee-js` directly as a script from [unpkg.com](https://unpkg.com/@ethersphere/bee-js/dist/index.browser.min.js).
@@ -86,8 +87,6 @@ under global namespace `BeeJs`:
8687
</script>
8788
```
8889

89-
90-
9190
## Quickstart with *create-swarm-app*
9291

9392
The `create-swarm-app` tool generates ready‑to‑run skeletons for `bee-js` projects in your chosen setup (CommonJS, ESM, TypeScript, or Vite + TypeScript) with a single command.
@@ -301,7 +300,13 @@ After selecting a file to upload, a reference hash to the file will be returned:
301300
302301
![](/img/develop-on-swarm-02.jpg)
303302
304-
Currently our application is running on localhost, and is only accessible locally. To make this application accessible for anyone on Swarm, all we need to do create a production build of our application using `vite build` and then upload it to the Swarm with `swarm-cli`.
303+
#### Using `swarm-cli` to Host on Swarm (optional)
304+
305+
:::tip
306+
Learn more about [hosting websites on Swarm](http://docs.ethswarm.org/docs/develop/access-the-swarm/host-your-website) in the official bee-docs.
307+
:::
308+
309+
Currently our application is running on localhost, and is only accessible locally. To make this application accessible for anyone on Swarm, all we need to do create a production build of our application using `vite build` and then upload it to the Swarm with `swarm-cli`.
305310
306311
```bash
307312
npm run build
@@ -332,8 +337,3 @@ The URL returned in the terminal can now be shared and accessed by anyone with a
332337
http://localhost:1633/bzz/764b08bb0f9e82d4bdce951b1ded816bd0417e039828e4308d61ab3035ff60a2/
333338
```
334339
335-
## Next Steps
336-
337-
As a next step, you may wish to look into [connecting your site to an ENS domain](https://docs.ethswarm.org/docs/develop/access-the-swarm/host-your-website/#enable-ens-on-your-node) so that it is accessible from a human-readable address.
338-
339-
You may also want to start exploring more the [example applications section (PLACEHOLDER)](#) along with the accompanying step-by-step guides to deepen your understanding of what's possible on Swarm.

src/css/custom.css

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,70 @@ article header h1,
206206
color: #FFAE42; /* Matches your hover color */
207207
}
208208

209-
/* Ensure info icon is visible in light mode */
210-
.alert--info .admonitionIcon_Rf37 svg path {
211-
fill: #FFF8DC !important;
209+
210+
[data-theme='dark'] .theme-admonition-note {
211+
background-color: #465158;
212+
border-color: #C1C9CF;
213+
}
214+
215+
[data-theme='dark'] .theme-admonition-tip {
216+
background-color: #0F6648;
217+
border-color: #00DAA1;
218+
}
219+
220+
[data-theme='dark'] .theme-admonition-info {
221+
background-color: #264C6E;
222+
border-color: #007FFF;
223+
}
224+
225+
[data-theme='dark'] .theme-admonition-caution {
226+
background-color: #784213;
227+
border-color: #F37300;
212228
}
229+
230+
[data-theme='dark'] .theme-admonition-danger {
231+
background-color: #791112;
232+
border-color: #F30000;
233+
}
234+
235+
236+
[data-theme='light'] .theme-admonition-note {
237+
background-color: #E5E9EC;
238+
border-color: #C1C9CF;
239+
}
240+
241+
[data-theme='light'] .theme-admonition-tip {
242+
background-color: #E0FFF4;
243+
border-color: #00DAA1;
244+
}
245+
246+
[data-theme='light'] .theme-admonition-info {
247+
background-color: #E2F1FF;
248+
border-color: #007FFF;
249+
}
250+
251+
[data-theme='light'] .theme-admonition-caution {
252+
background-color: #FDE9D7;
253+
border-color: #F37300;
254+
}
255+
256+
[data-theme='light'] .theme-admonition-danger {
257+
background-color: #FECDCD;
258+
border-color: #F30000;
259+
}
260+
261+
/* Style links inside admonitions */
262+
.theme-admonition a {
263+
font-weight: 600; /* slightly bold, not as heavy as 700 */
264+
text-decoration: none; /* remove default underline */
265+
border-bottom: 2px solid currentColor; /* underline effect using border */
266+
padding-bottom: 1px; /* spacing so border doesn’t touch text */
267+
}
268+
269+
/* Hover/focus state for better interactivity */
270+
.theme-admonition a:hover,
271+
.theme-admonition a:focus {
272+
color: var(--ifm-color-primary); /* matches your orange accent */
273+
border-bottom-color: var(--ifm-color-primary);
274+
}
275+

0 commit comments

Comments
 (0)