An open API service indexing awesome lists of open source software.

https://github.com/dioxuslabs/docsite

Dioxuslabs.com documentation site
https://github.com/dioxuslabs/docsite

Last synced: about 1 year ago
JSON representation

Dioxuslabs.com documentation site

Awesome Lists containing this project

README

          

# dioxuslabs.com

This repository contains the source code for the https://dioxuslabs.com website.

This website is written with Dioxus, pre-generated with `dioxus_ssr`, and then
rehydrated with interactivity provided by `dioxus_web`.

## Development

The docsite uses the newest Tailwind (v4) so you need to install it first and then run it using:

```sh
npx @tailwindcss/cli -i ./tailwind.css -o ./assets/tailwind.css --watch
```

The documentation can be edited using any text editor. Most commonly used
editors support syntax highlighting for the `markdown` format. To view your
changes you can install the [`dx`][dx] tool locally, assuming you already have a
working `Rust` setup:

```sh
cargo install dioxus-cli
```

With [`dx`][dx] installed, you can use it to build and serve the documentation
on your local system:

```sh
dx serve
```

This will start a local server that will be available on
[localhost:8080](localhost:8080) and will automatically build and re-build the
documentation when it changes.

## Contributing

- Check out the website [section on contributing]
- Report issues on our [issue tracker]
- Join the discord and ask questions!



[dx]: https://github.com/DioxusLabs/dioxus/tree/main/packages/cli
[section on contributing]: https://dioxuslabs.com/learn/0.6/contributing
[issue tracker]: https://github.com/dioxuslabs/docsite/issues