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 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 tool locally, assuming you already have a working Rust setup:

cargo binstall dioxus-cli@0.7.0-alpha.3 --force

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

dx serve --package dioxus_docs_site --hotpatch

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

We use TailwindCSS which is included automatically with dx 0.7.

Dioxus 0.7 Overhaul Progress

We are overhauling the docs for Dioxus 0.7. Here is the current progress:

✅ - [Core Concepts](essentials/index.md)
✅   - [Building User Interfaces](essentials/ui/index.md)
✅     - [Introducing RSX](essentials/ui/rsx.md)
✅     - [Elements and Text](essentials/ui/elements.md)
✅     - [Dynamic Attributes](essentials/ui/attributes.md)
✅     - [Components and Properties](essentials/ui/components.md)
✅     - [How Components Render](essentials/ui/render.md)
❌     - [Conditional Rendering](essentials/ui/conditional.md)
❌     - [Rendering Lists](essentials/ui/iteration.md)
❌     - [Escape Hatches](essentials/ui/escape.md)
❌     - [Assets](essentials/ui/assets.md)
❌     - [Styling](essentials/ui/styling.md)
❌     - [Hot-Reload](essentials/ui/hotreload.md)
❌   - [Reactivity](essentials/reactivity/index.md)
❌     - [Thinking Reactively](essentials/reactivity/reactivity.md)
❌     - [Handling Events](essentials/reactivity/event_handlers.md)
❌     - [Using Signals](essentials/reactivity/signals.md)
❌     - [Component Lifecycle](essentials/reactivity/lifecycle.md)
❌     - [Using Effects](essentials/reactivity/effects.md)
❌     - [Maintaing Purity](essentials/reactivity/purity.md)
❌     - [Reactive Collections](essentials/reactivity/collections.md)
❌   - [Managing State](essentials/state/index.md)
❌     - [State is Essential](essentials/state/essential.md)
❌     - [Local State](essentials/state/state.md)
❌     - [Hooks](essentials/state/hooks.md)
❌     - [Custom Hooks](essentials/state/custom_hooks.md)
❌     - [Passing State](essentials/state/passing.md)
❌     - [Context](essentials/state/context.md)
❌     - [Global State](essentials/state/global_state.md)
❌     - [Memoization](essentials/state/memoization.md)
❌     - [Optimization](essentials/state/optimization.md)
❌     - [Error Handling](essentials/state/error_handling.md)
❌   - [Async](essentials/async/index.md)
❌     - [Spawning Futures](essentials/async/futures.md)
❌     - [Async Resources](essentials/async/resources.md)
❌     - [Making network requests](essentials/async/network_requests.md)
❌     - [Suspense](essentials/async/suspense.md)
❌     - [Parallelism](essentials/async/parallel.md)
❌   - [Routing](essentials/router/index.md)
❌     - [Defining Routes](essentials/router/routes.md)
✅     - [Nested Routes](essentials/router/nested-routes.md)
✅     - [Layouts](essentials/router/layouts.md)
✅     - [Navigation](essentials/router/navigation/index.md)
✅     - [Programmatic Navigation](essentials/router/programmatic-navigation.md)
✅     - [History Providers](essentials/router/history-providers.md)
✅     - [History Buttons](essentials/router/history-buttons.md)
✅     - [Routing Update Callback](essentials/router/routing-update-callback.md)
✅   - [Fullstack](essentials/fullstack/index.md)
✅     - [Hydration](essentials/fullstack/hydration.md)
✅     - [Managing Dependencies](essentials/fullstack/managing_dependencies.md)
✅   	- [Server Functions](essentials/fullstack/server_functions.md)
✅   	- [Extractors](essentials/fullstack/extractors.md)
✅   	- [Middleware](essentials/fullstack/middleware.md)
✅   	- [Authentication](essentials/fullstack/authentication.md)
✅   	- [Routing](essentials/fullstack/routing.md)
✅     - [Streaming](essentials/fullstack/streaming.md)
✅     - [Static Site Generation](essentials/fullstack/static_site_generation.md)
✅     - [Axum Integration](essentials/fullstack/axum.md)
❌   - [Breaking Out](essentials/breaking/index.md)

---

❌ - [Guides](guides/index.md)
❌   - [Tools](guides/tools/index.md)
❌     - [Serve](guides/tools/serve.md)
❌     - [Bundle](guides/tools/bundle.md)
❌     - [Create a Project](guides/tools/creating.md)
❌     - [Configure Project](guides/tools/configure.md)
❌     - [Android](guides/tools/android.md)
❌     - [iOS](guides/tools/ios.md)
❌     - [Translate HTML](guides/tools/translate.md)
❌     - [VSCode Extension](guides/tools/vscode.md)
❌   - [Platform Support](guides/platforms/index.md)
❌     - [Web](guides/platforms/web.md)
❌     - [Desktop](guides/platforms/desktop.md)
❌     - [Mobile](guides/platforms/mobile.md)
❌   - [Publishing](guides/deploy/index.md)
❌     - [Web Apps](guides/deploy/web.md)
❌     - [SSG](guides/deploy/ssg.md)
❌     - [iOS Apps](guides/deploy/ios.md)
❌     - [macOS Apps](guides/deploy/macos.md)
❌     - [Linux Apps](guides/deploy/linux.md)
❌     - [Windows Apps](guides/deploy/windows.md)
❌     - [Android Apps](guides/deploy/android.md)
❌     - [Bundle Config](guides/deploy/config.md)
❌   - [Organizing your Project](guides/organization/index.md)
❌     - [Single Files](guides/organization/single.md)
❌     - [Workspaces](guides/organization/workspaces.md)
❌     - [Shared Code](guides/organization/shared.md)
❌   - [Testing and Debugging](guides/testing/index.md)
❌     - [Web](guides/testing/web.md)
❌     - [Desktop](guides/testing/desktop.md)
❌     - [Debugging](guides/testing/debugging.md)
❌     - [Continuous Integration](guides/testing/ci.md)
❌     - [Docker](guides/testing/docker.md)
❌     - [Optimizing](guides/tips/optimizing.md)
❌     - [Anti-patterns](guides/tips/antipatterns.md)
❌   - [Utilities](guides/utilities/index.md)
❌     - [Logging](guides/utilities/logging.md)
❌     - [Internationalization](guides/utilities/internationalization.md)
❌     - [Tailwind](guides/utilities/tailwind.md)
❌   - [In-Depth](guides/depth/index.md)
❌     - [Asset Pipeline](guides/depth/assets.md)
❌     - [Custom Renderer](guides/depth/custom_renderer.md)
❌   - [Migration](migration/index.md)
✅     - [To 0.7](migration/to_07.md)
✅     - [To 0.6](migration/to_06.md)
✅     - [To 0.5](migration/to_05/index.md)
✅       - [Hooks](migration/to_05/hooks.md)
✅         - [State](migration/to_05/state.md)
✅       - [Fermi](migration/to_05/fermi.md)
✅       - [Props](migration/to_05/props.md)

Contributing

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