Skip to content

Commit

Permalink
Update edit url and remove waveterm-docs refs and fix fontawesome (#1221
Browse files Browse the repository at this point in the history
)
  • Loading branch information
esimkowitz authored Nov 6, 2024
1 parent e478a86 commit 6aaa62a
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 45 deletions.
32 changes: 31 additions & 1 deletion .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ const config: StorybookConfig = {
return mergedConfig;
},

staticDirs: [{ from: "../assets", to: "/assets" }],
staticDirs: [
{ from: "../assets", to: "/assets" },
{ from: "../public/fontawesome", to: "/fontawesome" },
],
managerHead: (head) => `
${head}
<link rel="shortcut icon" href="./assets/waveterm-logo-with-bg.ico" />
Expand All @@ -48,5 +51,32 @@ const config: StorybookConfig = {
max-height: 100px !important;
}
</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;
25 changes: 0 additions & 25 deletions .storybook/preview-head.html

This file was deleted.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

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

Expand Down
33 changes: 16 additions & 17 deletions docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ hide_title: 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

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
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)
**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 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:

* [Widgets](./widgets)
* [Configuration](./config)
* [Key Bindings](./keybindings)
* [wsh command](./wsh)
* [Connections](./connections)
* [Custom Widgets](./customwidgets)
* [Telemetry](./telemetry)
* [FAQ](./faq)
- [Widgets](./widgets)
- [Configuration](./config)
- [Key Bindings](./keybindings)
- [wsh command](./wsh)
- [Connections](./connections)
- [Custom Widgets](./customwidgets)
- [Telemetry](./telemetry)
- [FAQ](./faq)

<!--
## Features
Expand All @@ -40,11 +40,10 @@ References:

## Links

* Homepage -- https://waveterm.dev
* Download -- https://waveterm.dev/download
* Discord -- https://discord.gg/XfvZ334gwU
* Main Github (source code) -- https://github.com/wavetermdev/waveterm/
* Docs Github (powers this site) -- https://github.com/wavetermdev/waveterm-docs/
- Homepage -- https://waveterm.dev
- Download -- https://waveterm.dev/download
- Discord -- https://discord.gg/XfvZ334gwU
- GitHub -- https://github.com/wavetermdev/waveterm/

## Looking for WaveLegacy documentation?

Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const config: Config = {
path: "docs",
routeBasePath: "/",
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,
],
"ideal-image",
Expand Down

0 comments on commit 6aaa62a

Please sign in to comment.