neicore / docsite

Dioxuslabs.com documentation site

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

Run the following command in the root of the project to start the tailwind css compiler:

npx tailwindcss -i ./input.css -o ./public/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 [dioxus-cli] tool locally, assuming you already have a working Rust setup;

cargo install dioxus-cli

With [dioxus] installed, you can use it to build and serve the documentation on your local system;

dx serve --example spa --features web

this will start a local server that will be available on localhost and will automatically build and re-build the documentation when it changes.

Contributing

Want to help out? Check out our The "Contributing" document

Conduct

The Tide project adheres to the Contributor Covenant Code of Conduct. This describes the minimum behavior expected from all contributors.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.