wf-components
Version:
This is the official component library for the Wireshark website, made by the Wireshark Foundation. It's currently a work in progress and will be updated regularly.
32 lines (24 loc) • 1.45 kB
Markdown
# 🦈 Wireshark Foundation Component Library
This is the official component library for the Wireshark website, made by the Wireshark Foundation. It's currently a work in progress and will be updated regularly.
## Setup
After installing this npm package, add the required css file to your site's `<head>` tag so that the components have the necessary styles:
```
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/wf-components/public/styles.css"
/>
```
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## Links
**[Learn more about the Wireshark Foundation](https://wiresharkfoundation.org)** <br/>
**[Wireshark homepage](https://wireshark.org)** <br/>
**[Donate to support open-source packet analysis!](https://wiresharkfoundation.org/donate)** <br/>