mirror of
https://github.com/DioxusLabs/dioxus
synced 2024-11-10 06:34:20 +00:00
update: match DioxusLabs/docs#3
This commit is contained in:
parent
e03f8ca90c
commit
1413631d30
10 changed files with 31 additions and 20 deletions
|
@ -101,10 +101,10 @@ cargo run --example EXAMPLE
|
|||
<table style="width:100%" align="center">
|
||||
<tr >
|
||||
<th><a href="https://dioxuslabs.com/guide/">Tutorial</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/web">Web</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/desktop/">Desktop</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/ssr/">SSR</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/mobile/">Mobile</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/platforms/web">Web</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/platforms/desktop/">Desktop</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/platforms/ssr/">SSR</a></th>
|
||||
<th><a href="https://dioxuslabs.com/reference/platforms/mobile/">Mobile</a></th>
|
||||
<th><a href="https://dioxuslabs.com/guide/concepts/managing_state.html">State</a></th>
|
||||
<tr>
|
||||
</table>
|
||||
|
|
|
@ -18,7 +18,7 @@ fn app(cx: Scope) -> Element {
|
|||
|
||||
In general, Dioxus and React share many functional similarities. If this guide is lacking in any general concept or an error message is confusing, React's documentation might be more helpful. We are dedicated to providing a *familiar* toolkit for UI in Rust, so we've chosen to follow in the footsteps of popular UI frameworks (React, Redux, etc). If you know React, then you already know Dioxus. If you don't know either, this guide will still help you!
|
||||
|
||||
> This is an introduction book! For advanced topics, check out the [Reference](https://dioxuslabs.com/reference) instead.
|
||||
> This is an introduction book! For advanced topics, check out the [Reference](/reference) instead.
|
||||
|
||||
## Multiplatform
|
||||
|
||||
|
@ -37,7 +37,7 @@ The Web is the best-supported target platform for Dioxus. To run on the Web, you
|
|||
|
||||
Because the web is a fairly mature platform, we expect there to be very little API churn for web-based features.
|
||||
|
||||
[Jump to the getting started guide for the web.]()
|
||||
[Jump to the getting started guide for the web.](/reference/platforms/web)
|
||||
|
||||
Examples:
|
||||
- [TodoMVC](https://github.com/DioxusLabs/example-projects/tree/master/todomvc)
|
||||
|
@ -55,7 +55,7 @@ For rendering statically to an `.html` file or from a WebServer, then you'll wan
|
|||
let contents = dioxus::ssr::render_vdom(&dom);
|
||||
```
|
||||
|
||||
[Jump to the getting started guide for SSR.]()
|
||||
[Jump to the getting started guide for SSR.](/reference/platforms/ssr)
|
||||
|
||||
Examples:
|
||||
- [Example DocSite](https://github.com/dioxusLabs/docsite)
|
||||
|
@ -68,13 +68,13 @@ The desktop is a powerful target for Dioxus, but is currently limited in capabil
|
|||
|
||||
Desktop APIs will likely be in flux as we figure out better patterns than our ElectronJS counterpart.
|
||||
|
||||
[Jump to the getting started guide for Desktop.]()
|
||||
[Jump to the getting started guide for Desktop.](/reference/platforms/desktop)
|
||||
|
||||
Examples:
|
||||
- [File explorer](https://github.com/dioxusLabs/file-explorer/)
|
||||
- [WiFi scanner](https://github.com/DioxusLabs/example-projects/blob/master/wifi-scanner)
|
||||
|
||||
[![File ExplorerExample](https://github.com/DioxusLabs/file-explorer-example/raw/master/image.png)](https://github.com/dioxusLabs/file-explorer/)
|
||||
[![File ExplorerExample](https://raw.githubusercontent.com/DioxusLabs/example-projects/master/file-explorer/image.png)](https://github.com/DioxusLabs/example-projects/tree/master/file-explorer)
|
||||
|
||||
### Mobile Support
|
||||
---
|
||||
|
@ -82,7 +82,7 @@ Mobile is currently the least-supported renderer target for Dioxus. Mobile apps
|
|||
|
||||
Mobile support is currently best suited for CRUD-style apps, ideally for internal teams who need to develop quickly but don't care much about animations or native widgets.
|
||||
|
||||
[Jump to the getting started guide for Mobile.]()
|
||||
[Jump to the getting started guide for Mobile.](/reference/platforms/mobile)
|
||||
|
||||
Examples:
|
||||
- [Todo App](https://github.com/DioxusLabs/example-projects/blob/master/ios_demo)
|
||||
|
|
|
@ -8,7 +8,7 @@ We'll learn about:
|
|||
- Suggested cargo extensions
|
||||
|
||||
|
||||
For platform-specific guides, check out the [Platform Specific Guides](../platforms/00-index.md).
|
||||
For platform-specific guides, check out the [Platform Specific Guides](/reference/platforms/index.md).
|
||||
|
||||
# Setting up Dioxus
|
||||
|
||||
|
|
|
@ -2,11 +2,12 @@
|
|||
|
||||
- [Introduction](README.md)
|
||||
|
||||
- [Web](web/index.md)
|
||||
- [Desktop](desktop/index.md)
|
||||
- [Mobile](mobile/index.md)
|
||||
- [SSR](ssr/index.md)
|
||||
- [TUI](tui/index.md)
|
||||
- [Platforms](platforms/index.md)
|
||||
- [Web](platforms/web.md)
|
||||
- [Server Side Rendering](platforms/ssr.md)
|
||||
- [Desktop](platforms/desktop.md)
|
||||
- [Mobile](platforms/mobile.md)
|
||||
- [TUI](platforms/tui.md)
|
||||
|
||||
- [Advanced Guides](guide/index.md)
|
||||
- [RSX in Depth](guide/rsx_in_depth.md)
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Desktop
|
||||
# Getting Started: Desktop
|
||||
|
||||
One of Dioxus' killer features is the ability to quickly build a native desktop app that looks and feels the same across platforms. Apps built with Dioxus are typically <5mb in size and use existing system resources, so they won't hog extreme amounts of RAM or memory.
|
||||
|
10
docs/reference/src/platforms/index.md
Normal file
10
docs/reference/src/platforms/index.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
# Platforms
|
||||
|
||||
Dioxus supports many different platforms. Below are a list of guides that walk you through setting up Dioxus for a specific platform.
|
||||
|
||||
### Setup Guides
|
||||
- [Web](web.md)
|
||||
- [Server Side Rendering](ssr.md)
|
||||
- [Desktop](desktop.md)
|
||||
- [Mobile](mobile.md)
|
||||
- [TUI](tui.md)
|
|
@ -21,7 +21,7 @@ $ cargo install --git https://github.com/BrainiumLLC/cargo-mobile
|
|||
And then initialize your app for the right platform. Use the `winit` template for now. Right now, there's no "Dioxus" template in cargo-mobile.
|
||||
|
||||
```shell
|
||||
$ cargo moble init
|
||||
$ cargo mobile init
|
||||
```
|
||||
|
||||
We're going to completely clear out the `dependencies` it generates for us, swapping out `winit` with `dioxus-mobile`.
|
|
@ -1,4 +1,4 @@
|
|||
# TUI
|
||||
# Getting Started: TUI
|
||||
|
||||
TUI support is currently quite experimental. Even the project name will change. But, if you're willing to venture into the realm of the unknown, this guide will get you started.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Getting Started: Dioxus for Web
|
||||
# Getting Started: Web
|
||||
|
||||
[*"Pack your things, we're going on an adventure!"*](https://trunkrs.dev)
|
||||
|
Loading…
Reference in a new issue