Update edit url and remove waveterm-docs refs and fix fontawesome (#1221)

This commit is contained in:
Evan Simkowitz 2024-11-06 12:24:53 -08:00 committed by GitHub
parent e478a86bf5
commit 6aaa62acdd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 49 additions and 45 deletions

View File

@ -37,7 +37,10 @@ const config: StorybookConfig = {
return mergedConfig; return mergedConfig;
}, },
staticDirs: [{ from: "../assets", to: "/assets" }], staticDirs: [
{ from: "../assets", to: "/assets" },
{ from: "../public/fontawesome", to: "/fontawesome" },
],
managerHead: (head) => ` managerHead: (head) => `
${head} ${head}
<link rel="shortcut icon" href="./assets/waveterm-logo-with-bg.ico" /> <link rel="shortcut icon" href="./assets/waveterm-logo-with-bg.ico" />
@ -48,5 +51,32 @@ const config: StorybookConfig = {
max-height: 100px !important; max-height: 100px !important;
} }
</style>`, </style>`,
previewHead: (head) => `
${head}
<link rel="stylesheet" href="./fontawesome/css/fontawesome.min.css" />
<link rel="stylesheet" href="./fontawesome/css/brands.min.css" />
<link rel="stylesheet" href="./fontawesome/css/solid.min.css" />
<link rel="stylesheet" href="./fontawesome/css/sharp-solid.min.css" />
<link rel="stylesheet" href="./fontawesome/css/sharp-regular.min.css" />
<style>
#storybook-docs {
[id^="anchor--"],
#stories {
a {
margin-left: -24px !important;
}
}
}
body {
background-color: #ffffff !important;
}
html.dark {
body {
background-color: #222222 !important;
}
}
</style>`,
}; };
export default config; export default config;

View File

@ -1,25 +0,0 @@
<link rel="stylesheet" href="/fontawesome/css/fontawesome.min.css" />
<link rel="stylesheet" href="/fontawesome/css/brands.min.css" />
<link rel="stylesheet" href="/fontawesome/css/solid.min.css" />
<link rel="stylesheet" href="/fontawesome/css/sharp-solid.min.css" />
<link rel="stylesheet" href="/fontawesome/css/sharp-regular.min.css" />
<style>
#storybook-docs {
[id^="anchor--"],
#stories {
a {
margin-left: -24px !important;
}
}
}
body {
background-color: #ffffff !important;
}
html.dark {
body {
background-color: #222222 !important;
}
}
</style>

View File

@ -43,7 +43,7 @@ To build and run Wave locally, see instructions at [Building Wave Terminal](./BU
We are working to document all our UI components in [Storybook](https://storybook.js.org/docs) for easy reference and testing. If you would like to help us with this, we would be very grateful! We are working to document all our UI components in [Storybook](https://storybook.js.org/docs) for easy reference and testing. If you would like to help us with this, we would be very grateful!
Our Storybook site is hosted [storybook.waveterm.dev](https://storybook.waveterm.dev). Our Storybook site is hosted [docs.waveterm.dev/storybook](https://docs.waveterm.dev/storybook).
### Create a Pull Request ### Create a Pull Request

View File

@ -6,25 +6,25 @@ hide_title: true
hide_table_of_contents: true hide_table_of_contents: true
--- ---
import {Card, CardGroup} from '@site/src/components/card.tsx'; import { Card, CardGroup } from "@site/src/components/card.tsx";
# Welcome to Wave Terminal # Welcome to Wave Terminal
Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Downloads](https://waveterm.dev/download)). Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Downloads](https://waveterm.dev/download)).
**These docs are incomplete**, but we're working on them. If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please **These docs are incomplete**, but we're working on them. If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please
use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs in our [docs repo](https://github.com/wavetermdev/waveterm-docs) use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs for docs [here](https://github.com/wavetermdev/waveterm/blob/main/docs). You can click the "Edit this page" link at the bottom of the page to get taken directly to the editor page for that document in GitHub.
References: References:
* [Widgets](./widgets) - [Widgets](./widgets)
* [Configuration](./config) - [Configuration](./config)
* [Key Bindings](./keybindings) - [Key Bindings](./keybindings)
* [wsh command](./wsh) - [wsh command](./wsh)
* [Connections](./connections) - [Connections](./connections)
* [Custom Widgets](./customwidgets) - [Custom Widgets](./customwidgets)
* [Telemetry](./telemetry) - [Telemetry](./telemetry)
* [FAQ](./faq) - [FAQ](./faq)
<!-- <!--
## Features ## Features
@ -40,11 +40,10 @@ References:
## Links ## Links
* Homepage -- https://waveterm.dev - Homepage -- https://waveterm.dev
* Download -- https://waveterm.dev/download - Download -- https://waveterm.dev/download
* Discord -- https://discord.gg/XfvZ334gwU - Discord -- https://discord.gg/XfvZ334gwU
* Main Github (source code) -- https://github.com/wavetermdev/waveterm/ - GitHub -- https://github.com/wavetermdev/waveterm/
* Docs Github (powers this site) -- https://github.com/wavetermdev/waveterm-docs/
## Looking for WaveLegacy documentation? ## Looking for WaveLegacy documentation?

View File

@ -38,7 +38,7 @@ const config: Config = {
path: "docs", path: "docs",
routeBasePath: "/", routeBasePath: "/",
exclude: ["features/**"], exclude: ["features/**"],
editUrl: !process.env.EMBEDDED ? "https://github.com/wavetermdev/waveterm-docs/edit/main/" : undefined, editUrl: !process.env.EMBEDDED ? "https://github.com/wavetermdev/waveterm/edit/main/docs/" : undefined,
} as import("@docusaurus/plugin-content-docs").Options, } as import("@docusaurus/plugin-content-docs").Options,
], ],
"ideal-image", "ideal-image",