Update more docs
This commit is contained in:
parent
16763c065b
commit
df23c3c651
|
@ -21,7 +21,7 @@ fn runs_in_browser() {
|
||||||
Then, when you run
|
Then, when you run
|
||||||
|
|
||||||
```console
|
```console
|
||||||
dioxus test --chrome
|
dx test --chrome
|
||||||
```
|
```
|
||||||
|
|
||||||
Dioxus will build and test your code using the Chrome browser as a harness.
|
Dioxus will build and test your code using the Chrome browser as a harness.
|
||||||
|
|
|
@ -18,7 +18,7 @@ Hot reloading is automatically enabled when using the web renderer on debug buil
|
||||||
1. Run:
|
1. Run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dioxus serve --hot-reload
|
dx serve --hot-reload
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Change some code within a rsx or render macro
|
2. Change some code within a rsx or render macro
|
||||||
|
|
|
@ -59,5 +59,5 @@ Edit your `main.rs`:
|
||||||
And to serve our app:
|
And to serve our app:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dioxus serve
|
dx serve
|
||||||
```
|
```
|
||||||
|
|
|
@ -18,7 +18,7 @@ dioxus = { version = "*", features = ["hot-reload"] }
|
||||||
1. Execute:
|
1. Execute:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve --hot-reload
|
dx serve --hot-reload
|
||||||
```
|
```
|
||||||
|
|
||||||
2. alterar algum código dentro de uma macro `rsx`
|
2. alterar algum código dentro de uma macro `rsx`
|
||||||
|
|
|
@ -18,7 +18,7 @@ dioxus = { version = "*", features = ["web", "hot_reload"] }
|
||||||
1. run:
|
1. run:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve --hot-reload
|
dx serve --hot-reload
|
||||||
```
|
```
|
||||||
|
|
||||||
2. alterar algum código dentro de uma macro rsx
|
2. alterar algum código dentro de uma macro rsx
|
||||||
|
|
|
@ -13,10 +13,10 @@ $ cargo new --bin demo
|
||||||
$ cd demo
|
$ cd demo
|
||||||
```
|
```
|
||||||
|
|
||||||
Add Dioxus with the `desktop` feature:
|
Add Dioxus-desktop:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ cargo add dioxus --features desktop
|
$ cargo add dioxus_desktop
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit your `main.rs`:
|
Edit your `main.rs`:
|
||||||
|
@ -26,7 +26,7 @@ Edit your `main.rs`:
|
||||||
use dioxus::prelude::*;
|
use dioxus::prelude::*;
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
dioxus::desktop::launch(app);
|
dioxus_desktop::launch(app);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn app(cx: Scope) -> Element {
|
fn app(cx: Scope) -> Element {
|
||||||
|
|
|
@ -60,7 +60,7 @@ fn app(cx: Scope) -> Element {
|
||||||
|
|
||||||
Our project is now setup! To make sure everything is running correctly, in the root of your project run:
|
Our project is now setup! To make sure everything is running correctly, in the root of your project run:
|
||||||
```
|
```
|
||||||
dioxus serve --platform web
|
dx serve --platform web
|
||||||
```
|
```
|
||||||
Then head to [http://localhost:8080](http://localhost:8080) in your browser, and you should see ``Hello, wasm!`` on your screen.
|
Then head to [http://localhost:8080](http://localhost:8080) in your browser, and you should see ``Hello, wasm!`` on your screen.
|
||||||
|
|
||||||
|
|
|
@ -122,7 +122,7 @@ npx tailwindcss -i ./input.css -o ./public/tailwind.css --watch
|
||||||
- Run the following command in the root of the project to start the dioxus dev server:
|
- Run the following command in the root of the project to start the dioxus dev server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dioxus serve --hot-reload
|
dx serve --hot-reload
|
||||||
```
|
```
|
||||||
|
|
||||||
- Open the browser to http://localhost:8080
|
- Open the browser to http://localhost:8080
|
||||||
|
|
|
@ -5,11 +5,11 @@ In this chapter we will introduce all `dioxus-cli` commands.
|
||||||
> You can also use `dx --help` to get cli help info.
|
> You can also use `dx --help` to get cli help info.
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus
|
dx
|
||||||
Build, bundle, & ship your Dioxus app
|
Build, bundle, & ship your Dioxus app
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
dioxus [OPTIONS] <SUBCOMMAND>
|
dx [OPTIONS] <SUBCOMMAND>
|
||||||
|
|
||||||
OPTIONS:
|
OPTIONS:
|
||||||
-h, --help Print help information
|
-h, --help Print help information
|
||||||
|
|
|
@ -7,12 +7,12 @@ dioxus-clean
|
||||||
Clean build artifacts
|
Clean build artifacts
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
dioxus clean
|
dx clean
|
||||||
```
|
```
|
||||||
|
|
||||||
# Example
|
# Example
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus clean
|
dx clean
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@ dioxus-serve
|
||||||
Build, watch & serve the Rust WASM app and all of its assets
|
Build, watch & serve the Rust WASM app and all of its assets
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
dioxus serve [OPTIONS]
|
dx serve [OPTIONS]
|
||||||
|
|
||||||
OPTIONS:
|
OPTIONS:
|
||||||
--example <EXAMPLE> [default: ""]
|
--example <EXAMPLE> [default: ""]
|
||||||
|
@ -19,7 +19,7 @@ OPTIONS:
|
||||||
You can use this command to build project and start a dev server:
|
You can use this command to build project and start a dev server:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve
|
dx serve
|
||||||
```
|
```
|
||||||
|
|
||||||
## Serve Example
|
## Serve Example
|
||||||
|
@ -28,7 +28,7 @@ You can use the `example` option to serve a example:
|
||||||
|
|
||||||
```
|
```
|
||||||
# serve the `test` example
|
# serve the `test` example
|
||||||
dioxus serve --exmaple test
|
dx serve --exmaple test
|
||||||
```
|
```
|
||||||
|
|
||||||
## Open Browser
|
## Open Browser
|
||||||
|
@ -36,7 +36,7 @@ dioxus serve --exmaple test
|
||||||
You can add the `--open` option to open system default browser when server startup:
|
You can add the `--open` option to open system default browser when server startup:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve --open
|
dx serve --open
|
||||||
```
|
```
|
||||||
|
|
||||||
## RSX Hot Reloading
|
## RSX Hot Reloading
|
||||||
|
@ -44,7 +44,7 @@ dioxus serve --open
|
||||||
You can add the `--hot-reload` flag to enable [rsx hot reloading](https://dioxuslabs.com/docs/0.3/guide/en/getting_started/hot_reload.html). This will allow you to reload some rsx changes without a full recompile:
|
You can add the `--hot-reload` flag to enable [rsx hot reloading](https://dioxuslabs.com/docs/0.3/guide/en/getting_started/hot_reload.html). This will allow you to reload some rsx changes without a full recompile:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve --open
|
dx serve --open
|
||||||
```
|
```
|
||||||
|
|
||||||
## Cross Origin Policy
|
## Cross Origin Policy
|
||||||
|
@ -57,5 +57,5 @@ You can add the `cross-origin-policy` option to change cross-origin header to:
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve --corss-origin-policy
|
dx serve --corss-origin-policy
|
||||||
```
|
```
|
||||||
|
|
|
@ -7,7 +7,7 @@ dioxus-translate
|
||||||
Translate some source file into a Dioxus component
|
Translate some source file into a Dioxus component
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
dioxus translate [OPTIONS] [OUTPUT]
|
dx translate [OPTIONS] [OUTPUT]
|
||||||
|
|
||||||
ARGS:
|
ARGS:
|
||||||
<OUTPUT> Output file, defaults to stdout if not present
|
<OUTPUT> Output file, defaults to stdout if not present
|
||||||
|
@ -22,7 +22,7 @@ OPTIONS:
|
||||||
You can use the `file` option to set path to the `html` file to translate:
|
You can use the `file` option to set path to the `html` file to translate:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus transtale --file ./index.html
|
dx transtale --file ./index.html
|
||||||
```
|
```
|
||||||
|
|
||||||
## Output rsx to a file
|
## Output rsx to a file
|
||||||
|
@ -30,7 +30,7 @@ dioxus transtale --file ./index.html
|
||||||
You can pass a file to the traslate command to set the path to write the output of the command to:
|
You can pass a file to the traslate command to set the path to write the output of the command to:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus translate --file ./index.html component.rsx
|
dx translate --file ./index.html component.rsx
|
||||||
```
|
```
|
||||||
|
|
||||||
## Output rsx to a file
|
## Output rsx to a file
|
||||||
|
@ -38,7 +38,7 @@ dioxus translate --file ./index.html component.rsx
|
||||||
Setting the `component` option will create a compoent from the HTML:
|
Setting the `component` option will create a compoent from the HTML:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus translate --file ./index.html --component
|
dx translate --file ./index.html --component
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -15,7 +15,7 @@ dioxus create hello-dioxus
|
||||||
>
|
>
|
||||||
> You can choose to create your project from a different template by passing the `template` argument:
|
> You can choose to create your project from a different template by passing the `template` argument:
|
||||||
> ```
|
> ```
|
||||||
> dioxus init hello-dioxus --template=gh:dioxuslabs/dioxus-template
|
> dx init hello-dioxus --template=gh:dioxuslabs/dioxus-template
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
Next, move the current directory into your new project:
|
Next, move the current directory into your new project:
|
||||||
|
@ -33,7 +33,7 @@ cd hello-dioxus
|
||||||
Finally, create serve your project with the Dioxus CLI:
|
Finally, create serve your project with the Dioxus CLI:
|
||||||
|
|
||||||
```
|
```
|
||||||
dioxus serve
|
dx serve
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, the CLI serve your site at: [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/)
|
By default, the CLI serve your site at: [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/)
|
||||||
|
|
Loading…
Reference in New Issue