waveterm/docs
dependabot[bot] 2916e01561
Bump the dev-dependencies-patch group with 2 updates (#1886)
Bumps the dev-dependencies-patch group with 2 updates:
[remark-preset-lint-consistent](https://github.com/remarkjs/remark-lint)
and
[remark-preset-lint-recommended](https://github.com/remarkjs/remark-lint).

Updates `remark-preset-lint-consistent` from 6.0.0 to 6.0.1
<details>
<summary>Commits</summary>
<ul>
<li>See full diff in <a
href="https://github.com/remarkjs/remark-lint/commits">compare
view</a></li>
</ul>
</details>
<br />

Updates `remark-preset-lint-recommended` from 7.0.0 to 7.0.1
<details>
<summary>Commits</summary>
<ul>
<li><a
href="750541e2fb"><code>750541e</code></a>
Publish a patch version for all packages</li>
<li><a
href="b40fe0f43e"><code>b40fe0f</code></a>
Change <code>master</code> in links</li>
<li><a
href="48a53935e5"><code>48a5393</code></a>
maximum-line-length: 2.0.1</li>
<li><a
href="2e3683a5cb"><code>2e3683a</code></a>
Update dev-dependencies</li>
<li><a
href="048f1dbca7"><code>048f1db</code></a>
maximum-line-length: fix <code>whitelist</code></li>
<li><a
href="1e314a86e6"><code>1e314a8</code></a>
no-shell-dollars: 2.0.1</li>
<li><a
href="cffce16d31"><code>cffce16</code></a>
remark-lint-unordered-list-marker-style: fix typos (<a
href="https://redirect.github.com/remarkjs/remark-lint/issues/235">#235</a>)</li>
<li><a
href="dc4f092be0"><code>dc4f092</code></a>
Ignore whitespace only lines too</li>
<li><a
href="3c896b35b0"><code>3c896b3</code></a>
Update dev-dependencies</li>
<li><a
href="7c04e5d4d0"><code>7c04e5d</code></a>
Fix missing check on one-line code-blocks</li>
<li>Additional commits viewable in <a
href="https://github.com/remarkjs/remark-lint/compare/7.0.0...7.0.1">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-01-31 10:43:30 -08:00
..
docs Remove unnecessary code block at bottom of wsh doc (#1867) 2025-01-28 19:48:38 -08:00
src Add code highlighting to docsite (#1866) 2025-01-28 19:38:43 -08:00
static Add sharp-solid font to docsite (#1813) 2025-01-23 12:23:24 -08:00
.editorconfig Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
.gitignore Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
.prettierignore Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
.remarkrc Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
babel.config.js Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
docusaurus.config.ts Add code highlighting to docsite (#1866) 2025-01-28 19:38:43 -08:00
eslint.config.js Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
package.json Bump the dev-dependencies-patch group with 2 updates (#1886) 2025-01-31 10:43:30 -08:00
prettier.config.cjs Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00
README.md add aliases for electron:dev, electron:start, and docsite:start tasks (#1651) 2024-12-29 10:05:17 -08:00
tsconfig.json Move docsite to main repo (#1204) 2024-11-06 10:45:21 -08:00

Wave Terminal Documentation

This is the home for Wave Terminal's documentation site. This README is specifically about building and contributing to the docs site. If you are looking for the actual hosted docs, go here -- https://docs.waveterm.dev

Installation

Our docs are built using Docusaurus, a modern static website generator.

yarn

Local Development

task docsite

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

task docsite:build:<embedded,public>

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployments are handled automatically by the Docsite and Storybook CI/CD workflow