""
] [Root,"count: 0"
] @@ -229,7 +229,7 @@ Like most GUIs, Dioxus relies on an event loop to progress the VirtualDOM. The V The code for the WebSys implementation is straightforward, so we'll add it here to demonstrate how simple an event loop is: -```rust, ignore +```rust, no_run, ignore pub async fn run(&mut self) -> dioxus_core::error::Result<()> { // Push the body element onto the WebsysDom's stack machine let mut websys_dom = crate::new::WebsysDom::new(prepare_websys_dom()); @@ -259,7 +259,7 @@ pub async fn run(&mut self) -> dioxus_core::error::Result<()> { It's important to decode what the real events are for your event system into Dioxus' synthetic event system (synthetic meaning abstracted). This simply means matching your event type and creating a Dioxus `UserEvent` type. Right now, the virtual event system is modeled almost entirely around the HTML spec, but we are interested in slimming it down. -```rust, ignore +```rust, no_run, ignore fn virtual_event_from_websys_event(event: &web_sys::Event) -> VirtualEvent { match event.type_().as_str() { "keydown" => { @@ -308,7 +308,7 @@ The `RealDom` is a higher-level abstraction over updating the Dom. It uses an en Let's build a toy renderer with borders, size, and text color. Before we start let's take a look at an example element we can render: -```rust +```rust, no_run cx.render(rsx!{ div{ color: "red", @@ -380,19 +380,19 @@ To help in building a Dom, native-core provides the State trait and a RealDom st Native Core cannot create all of the required methods for the State trait, but it can derive some of them. To implement the State trait, you must implement the following methods and let the `#[partial_derive_state]` macro handle the rest: -```rust, ignore +```rust, no_run, ignore {{#include ../../../examples/custom_renderer.rs:derive_state}} ``` Lets take a look at how to implement the State trait for a simple renderer. -```rust +```rust, no_run {{#include ../../../examples/custom_renderer.rs:state_impl}} ``` Now that we have our state, we can put it to use in our RealDom. We can update the RealDom with apply_mutations to update the structure of the dom (adding, removing, and changing properties of nodes) and then update_state to update the States for each of the nodes that changed. -```rust +```rust, no_run {{#include ../../../examples/custom_renderer.rs:rendering}} ``` @@ -404,7 +404,7 @@ For most platforms, the layout of the Elements will stay the same. The [layout_a To make it easier to implement text editing in rust renderers, `native-core` also contains a renderer-agnostic cursor system. The cursor can handle text editing, selection, and movement with common keyboard shortcuts integrated. -```rust +```rust, no_run {{#include ../../../examples/custom_renderer.rs:cursor}} ``` diff --git a/docs/guide/src/en/describing_ui/component_children.md b/docs/guide/src/en/describing_ui/component_children.md index 02be25cd5..7e329abbc 100644 --- a/docs/guide/src/en/describing_ui/component_children.md +++ b/docs/guide/src/en/describing_ui/component_children.md @@ -2,13 +2,13 @@ In some cases, you may wish to create a component that acts as a container for some other content, without the component needing to know what that content is. To achieve this, create a prop of type `Element`: -```rust +```rust, no_run {{#include ../../../examples/component_element_props.rs:Clickable}} ``` Then, when rendering the component, you can pass in the output of `cx.render(rsx!(...))`: -```rust +```rust, no_run {{#include ../../../examples/component_element_props.rs:Clickable_usage}} ``` @@ -20,12 +20,12 @@ Then, when rendering the component, you can pass in the output of `cx.render(rsx Rather than passing the RSX through a regular prop, you may wish to accept children similarly to how elements can have children. The "magic" `children` prop lets you achieve this: -```rust +```rust, no_run {{#include ../../../examples/component_children.rs:Clickable}} ``` This makes using the component much simpler: simply put the RSX inside the `{}` brackets – and there is no need for a `render` call or another macro! -```rust +```rust, no_run {{#include ../../../examples/component_children.rs:Clickable_usage}} ``` diff --git a/docs/guide/src/en/describing_ui/component_props.md b/docs/guide/src/en/describing_ui/component_props.md index 9c5cd4be3..947ec5f70 100644 --- a/docs/guide/src/en/describing_ui/component_props.md +++ b/docs/guide/src/en/describing_ui/component_props.md @@ -7,6 +7,7 @@ Just like you can pass arguments to a function, you can pass props to a componen Component props are a single struct annotated with `#[derive(Props)]`. For a component to accept props, the type of its argument must be `Scope
-
```
@@ -67,14 +75,15 @@ Similarly to how you can [format](https://doc.rust-lang.org/rust-by-example/hell
To add children to an element, put them inside the `{}` brackets after all attributes and listeners in the element. They can be other elements, text, or [components](components.md). For example, you could have an `ol` (ordered list) element, containing 3 `li` (list item) elements, each of which contains some text:
-```rust
+```rust, no_run
{{#include ../../../examples/rsx_overview.rs:children}}
```
+
```html
ES
- 42
- {}
+ ES
+ 42
+ {}
-
-
- First Item -
- Second Item -
- Third Item +
- First Item +
- Second Item +
- Third Item
0
1
@@ -122,9 +133,10 @@ In addition to iterators you can also use for loops directly within RSX:
You can also use if statements without an else branch within RSX:
-```rust
+```rust, no_run
{{#include ../../../examples/rsx_overview.rs:ifstatements}}
```
+
```html
true
-```
\ No newline at end of file
+```
diff --git a/docs/guide/src/en/describing_ui/special_attributes.md b/docs/guide/src/en/describing_ui/special_attributes.md
index 7bed1ef94..4ba7a40f1 100644
--- a/docs/guide/src/en/describing_ui/special_attributes.md
+++ b/docs/guide/src/en/describing_ui/special_attributes.md
@@ -8,8 +8,7 @@ If you're working with pre-rendered assets, output from templates, or output fro
For example, shipping a markdown-to-Dioxus converter might significantly bloat your final application size. Instead, you'll want to pre-render your markdown to HTML and then include the HTML directly in your output. We use this approach for the [Dioxus homepage](https://dioxuslabs.com):
-
-```rust
+```rust, no_run
{{#include ../../../examples/dangerous_inner_html.rs:dangerous_inner_html}}
```
@@ -17,21 +16,21 @@ For example, shipping a markdown-to-Dioxus converter might significantly bloat y
>
> If you're handling untrusted input, make sure to sanitize your HTML before passing it into `dangerous_inner_html` – or just pass it to a Text Element to escape any HTML tags.
-
## Boolean Attributes
Most attributes, when rendered, will be rendered exactly as the input you provided. However, some attributes are considered "boolean" attributes and just their presence determines whether they affect the output. For these attributes, a provided value of `"false"` will cause them to be removed from the target element.
So this RSX wouldn't actually render the `hidden` attribute:
-```rust
+```rust, no_run
{{#include ../../../examples/boolean_attribute.rs:boolean_attribute}}
```
+
```html
hello
```
-Not all attributes work like this however. *Only the following attributes* have this behavior:
+Not all attributes work like this however. _Only the following attributes_ have this behavior:
- `allowfullscreen`
- `allowpaymentrequest`
diff --git a/docs/guide/src/en/fullstack/getting_started.md b/docs/guide/src/en/fullstack/getting_started.md
index 8e753e2c9..9511b8a6c 100644
--- a/docs/guide/src/en/fullstack/getting_started.md
+++ b/docs/guide/src/en/fullstack/getting_started.md
@@ -39,7 +39,7 @@ tokio = { version = "*", features = ["full"] }
Now, set up your Axum app to serve the Dioxus app.
-```rust
+```rust, no_run
{{#include ../../../examples/server_basic.rs}}
```
@@ -72,7 +72,7 @@ web = ["dioxus-web"]
Next, we need to modify our `main.rs` to use either hydrate on the client or render on the server depending on the active features.
-```rust
+```rust, no_run
{{#include ../../../examples/hydration.rs}}
```
@@ -95,7 +95,7 @@ To do this, we must remove the serve_dioxus_application and replace it with a cu
The only thing we need to change on the client is the props. `dioxus-fullstack` will automatically serialize the props it uses to server render the app and send them to the client. In the client section of `main.rs`, we need to add `get_root_props_from_document` to deserialize the props before we hydrate the app.
-```rust
+```rust, no_run
{{#include ../../../examples/hydration_props.rs}}
```
diff --git a/docs/guide/src/en/fullstack/server_functions.md b/docs/guide/src/en/fullstack/server_functions.md
index b9d40ed2c..57883885a 100644
--- a/docs/guide/src/en/fullstack/server_functions.md
+++ b/docs/guide/src/en/fullstack/server_functions.md
@@ -20,7 +20,7 @@ cargo add serde
Next, add the server function to your `main.rs`:
-```rust
+```rust, no_run
{{#include ../../../examples/server_function.rs}}
```
diff --git a/docs/guide/src/en/getting_started/desktop.md b/docs/guide/src/en/getting_started/desktop.md
index b24215218..42fe5c1a2 100644
--- a/docs/guide/src/en/getting_started/desktop.md
+++ b/docs/guide/src/en/getting_started/desktop.md
@@ -72,6 +72,6 @@ cargo add dioxus-desktop
Edit your `main.rs`:
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_desktop.rs:all}}
```
diff --git a/docs/guide/src/en/getting_started/hot_reload.md b/docs/guide/src/en/getting_started/hot_reload.md
index 2ebf5e4aa..b14de30a4 100644
--- a/docs/guide/src/en/getting_started/hot_reload.md
+++ b/docs/guide/src/en/getting_started/hot_reload.md
@@ -36,7 +36,7 @@ For more information about hot reloading on native platforms and configuration o
Add the following to your main function:
-```rust
+```rust, no_run
fn main() {
hot_reload_init!();
// launch your application
diff --git a/docs/guide/src/en/getting_started/liveview.md b/docs/guide/src/en/getting_started/liveview.md
index 54f792e74..56847cab5 100644
--- a/docs/guide/src/en/getting_started/liveview.md
+++ b/docs/guide/src/en/getting_started/liveview.md
@@ -1,18 +1,17 @@
# Liveview
-Liveview allows apps to *run* on the server and *render* in the browser. It uses WebSockets to communicate between the server and the browser.
+Liveview allows apps to _run_ on the server and _render_ in the browser. It uses WebSockets to communicate between the server and the browser.
Examples:
+
- [Axum Example](https://github.com/DioxusLabs/dioxus/tree/master/packages/liveview/examples/axum.rs)
- [Salvo Example](https://github.com/DioxusLabs/dioxus/tree/master/packages/liveview/examples/salvo.rs)
- [Warp Example](https://github.com/DioxusLabs/dioxus/tree/master/packages/liveview/examples/warp.rs)
-
## Support
Liveview is currently limited in capability when compared to the Web platform. Liveview apps run on the server in a native thread. This means that browser APIs are not available, so rendering WebGL, Canvas, etc is not as easy as the Web. However, native system APIs are accessible, so streaming, WebSockets, filesystem, etc are all viable APIs.
-
## Setup
For this guide, we're going to show how to use Dioxus Liveview with [Axum](https://docs.rs/axum/latest/axum/).
@@ -50,17 +49,14 @@ tokio = { version = "1.15.0", features = ["full"] }
Now, set up your Axum app to respond on an endpoint.
-
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_liveview.rs:glue}}
```
-
And then add our app component:
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_liveview.rs:app}}
```
And that's it!
-
diff --git a/docs/guide/src/en/getting_started/mobile.md b/docs/guide/src/en/getting_started/mobile.md
index 2f93b807c..72d597f51 100644
--- a/docs/guide/src/en/getting_started/mobile.md
+++ b/docs/guide/src/en/getting_started/mobile.md
@@ -5,8 +5,8 @@ Build a mobile app with Dioxus!
Example: [Todo App](https://github.com/DioxusLabs/example-projects/blob/master/ios_demo)
## Support
-Mobile is currently the least-supported renderer target for Dioxus. Mobile apps are rendered with either the platform's WebView or experimentally through [WGPU](https://github.com/DioxusLabs/blitz). WebView doesn't support animations, transparency, and native widgets.
+Mobile is currently the least-supported renderer target for Dioxus. Mobile apps are rendered with either the platform's WebView or experimentally through [WGPU](https://github.com/DioxusLabs/blitz). WebView doesn't support animations, transparency, and native widgets.
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.
@@ -59,7 +59,7 @@ simple_logger = "*"
Edit your `lib.rs`:
-```rust
+```rust, no_run
use dioxus::prelude::*;
fn main() {
@@ -73,4 +73,4 @@ fn app(cx: Scope) -> Element {
}
})
}
-```
\ No newline at end of file
+```
diff --git a/docs/guide/src/en/getting_started/ssr.md b/docs/guide/src/en/getting_started/ssr.md
index 7a1954191..080efbb6d 100644
--- a/docs/guide/src/en/getting_started/ssr.md
+++ b/docs/guide/src/en/getting_started/ssr.md
@@ -39,19 +39,19 @@ tokio = { version = "1.15.0", features = ["full"] }
Now, set up your Axum app to respond on an endpoint.
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_ssr.rs:main}}
```
And then add our endpoint. We can either render `rsx!` directly:
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_ssr.rs:endpoint}}
```
Or we can render VirtualDoms.
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_ssr.rs:second_endpoint}}
```
diff --git a/docs/guide/src/en/getting_started/tui.md b/docs/guide/src/en/getting_started/tui.md
index 4e8d36cf9..504c01212 100644
--- a/docs/guide/src/en/getting_started/tui.md
+++ b/docs/guide/src/en/getting_started/tui.md
@@ -29,7 +29,7 @@ cargo add dioxus-tui
Then, edit your `main.rs` with the basic template.
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_tui.rs}}
```
@@ -41,6 +41,6 @@ cargo run
Press "ctrl-c" to close the app. To switch from "ctrl-c" to just "q" to quit you can launch the app with a configuration to disable the default quit and use the root TuiContext to quit on your own.
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_tui_no_ctrl_c.rs}}
```
diff --git a/docs/guide/src/en/getting_started/web.md b/docs/guide/src/en/getting_started/web.md
index e8a1f3da2..b29b8d691 100644
--- a/docs/guide/src/en/getting_started/web.md
+++ b/docs/guide/src/en/getting_started/web.md
@@ -17,7 +17,7 @@ Examples:
The Web is the best-supported target platform for Dioxus.
-- Because your app will be compiled to WASM you have access to browser APIs through [wasm-bingen](https://rustwasm.github.io/docs/wasm-bindgen/introduction.html).
+- Because your app will be compiled to WASM you have access to browser APIs through [wasm-bindgen](https://rustwasm.github.io/docs/wasm-bindgen/introduction.html).
- Dioxus provides hydration to resume apps that are rendered on the server. See the [fullstack](fullstack.md) getting started guide for more information.
## Tooling
@@ -52,7 +52,7 @@ cargo add dioxus-web
Edit your `main.rs`:
-```rust
+```rust, no_run
{{#include ../../../examples/hello_world_web.rs}}
```
diff --git a/docs/guide/src/en/index.md b/docs/guide/src/en/index.md
index 332d5957b..bbebb0bc9 100644
--- a/docs/guide/src/en/index.md
+++ b/docs/guide/src/en/index.md
@@ -4,7 +4,7 @@
Dioxus is a portable, performant, and ergonomic framework for building cross-platform user interfaces in Rust. This guide will help you get started with writing Dioxus apps for the Web, Desktop, Mobile, and more.
-```rust
+```rust, no_run
fn app(cx: Scope) -> Element {
let mut count = use_state(cx, || 0);
@@ -18,7 +18,7 @@ fn app(cx: Scope) -> Element {
Dioxus is heavily inspired by React. If you know React, getting started with Dioxus will be a breeze.
-> This guide assumes you already know some [Rust](https://www.rust-lang.org/)! If not, we recommend reading [*the book*](https://doc.rust-lang.org/book/ch01-00-getting-started.html) to learn Rust first.
+> This guide assumes you already know some [Rust](https://www.rust-lang.org/)! If not, we recommend reading [_the book_](https://doc.rust-lang.org/book/ch01-00-getting-started.html) to learn Rust first.
## Features
@@ -31,9 +31,10 @@ Dioxus is heavily inspired by React. If you know React, getting started with Dio
### Multiplatform
-Dioxus is a *portable* toolkit, meaning the Core implementation can run anywhere with no platform-dependent linking. Unlike many other Rust frontend toolkits, Dioxus is not intrinsically linked to WebSys. In fact, every element and event listener can be swapped out at compile time. By default, Dioxus ships with the `html` feature enabled, but this can be disabled depending on your target renderer.
+Dioxus is a _portable_ toolkit, meaning the Core implementation can run anywhere with no platform-dependent linking. Unlike many other Rust frontend toolkits, Dioxus is not intrinsically linked to WebSys. In fact, every element and event listener can be swapped out at compile time. By default, Dioxus ships with the `html` feature enabled, but this can be disabled depending on your target renderer.
Right now, we have several 1st-party renderers:
+
- WebSys (for WASM): Great support
- Tao/Tokio (for Desktop apps): Good support
- Tao/Tokio (for Mobile apps): Poor support
diff --git a/docs/guide/src/en/interactivity/custom_hooks.md b/docs/guide/src/en/interactivity/custom_hooks.md
index f3acec269..d075bb632 100644
--- a/docs/guide/src/en/interactivity/custom_hooks.md
+++ b/docs/guide/src/en/interactivity/custom_hooks.md
@@ -10,13 +10,13 @@ To avoid repetition, you can encapsulate business logic based on existing hooks
For example, if many components need to access an `AppSettings` struct, you can create a "shortcut" hook:
-```rust
+```rust, no_run
{{#include ../../../examples/hooks_composed.rs:wrap_context}}
```
Or if you want to wrap a hook that persists reloads with the storage API, you can build on top of the use_ref hook to work with mutable state:
-```rust
+```rust, no_run
{{#include ../../../examples/hooks_composed.rs:use_storage}}
```
@@ -34,7 +34,7 @@ Inside the initialization closure, you will typically make calls to other `cx` m
Here is a simplified implementation of the `use_state` hook:
-```rust
+```rust, no_run
{{#include ../../../examples/hooks_custom_logic.rs:use_state}}
```
@@ -42,7 +42,7 @@ Here is a simplified implementation of the `use_state` hook:
Here is an implementation of the `use_context` and `use_context_provider` hooks:
-```rust
+```rust, no_run
{{#include ../../../examples/hooks_custom_logic.rs:use_context}}
```
@@ -54,13 +54,13 @@ When writing a custom hook, you should avoid the following anti-patterns:
This version of use_state may seem more efficient, but it is not cloneable:
-```rust
+```rust, no_run
{{#include ../../../examples/hooks_anti_patterns.rs:non_clone_state}}
```
If we try to use this hook in an async block, we will get a compile error:
-```rust
+```rust, no_run
fn FutureComponent(cx: &ScopeState) -> Element {
let my_state = my_use_state(cx, || 0);
cx.spawn({
@@ -76,7 +76,7 @@ fn FutureComponent(cx: &ScopeState) -> Element {
But with the original version, we can use it in an async block:
-```rust
+```rust, no_run
fn FutureComponent(cx: &ScopeState) -> Element {
let my_state = use_state(cx, || 0);
cx.spawn({
diff --git a/docs/guide/src/en/interactivity/dynamic_rendering.md b/docs/guide/src/en/interactivity/dynamic_rendering.md
index 5c7ba1314..8d91650c3 100644
--- a/docs/guide/src/en/interactivity/dynamic_rendering.md
+++ b/docs/guide/src/en/interactivity/dynamic_rendering.md
@@ -6,7 +6,7 @@ Sometimes you want to render different things depending on the state/props. With
To render different elements based on a condition, you could use an `if-else` statement:
-```rust
+```rust, no_run
{{#include ../../../examples/conditional_rendering.rs:if_else}}
```
@@ -18,7 +18,7 @@ You may have noticed some repeated code in the `if-else` example above. Repeatin
We can improve this example by splitting up the dynamic parts and inserting them where they are needed.
-```rust
+```rust, no_run
{{#include ../../../examples/conditional_rendering.rs:if_else_improved}}
```
@@ -26,18 +26,17 @@ We can improve this example by splitting up the dynamic parts and inserting them
Since `Element` is a `Option ![](\"./notes/header.svg\")
+
+**dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running.
+It handles all build, bundling, development and publishing to simplify web development.
+
+
+## Installation
+
+### Install stable version
+```
+cargo install dioxus-cli
+```
+### Install from git repository
+```
+cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli
+```
+### Install from local folder
+```
+cargo install --path . --debug
+```
+
+
+## Get Started
+
+Use `dioxus create project-name` to initialize a new Dioxus project. 📦✨ Dioxus CLI
+Tooling to supercharge Dioxus projects
++ +It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository. + +
+ +Alternatively, you can specify the template path: + +``` +dioxus create hello --template gh:dioxuslabs/dioxus-template +``` + +## Dioxus Config File + +Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature. + +You can get more configure information from [Dioxus CLI Document](https://dioxuslabs.com/cli/configure.html). diff --git a/packages/cli/build.rs b/packages/cli/build.rs new file mode 100644 index 000000000..15935e2da --- /dev/null +++ b/packages/cli/build.rs @@ -0,0 +1,50 @@ +//! Construct version in the `commit-hash date channel` format + +use std::{env, path::PathBuf, process::Command}; + +fn main() { + set_rerun(); + set_commit_info(); + if option_env!("CFG_RELEASE").is_none() { + println!("cargo:rustc-env=POKE_RA_DEVS=1"); + } +} + +fn set_rerun() { + println!("cargo:rerun-if-env-changed=CFG_RELEASE"); + + let mut manifest_dir = PathBuf::from( + env::var("CARGO_MANIFEST_DIR").expect("`CARGO_MANIFEST_DIR` is always set by cargo."), + ); + + while manifest_dir.parent().is_some() { + let head_ref = manifest_dir.join(".git/HEAD"); + if head_ref.exists() { + println!("cargo:rerun-if-changed={}", head_ref.display()); + return; + } + + manifest_dir.pop(); + } + + println!("cargo:warning=Could not find `.git/HEAD` from manifest dir!"); +} + +fn set_commit_info() { + let output = match Command::new("git") + .arg("log") + .arg("-1") + .arg("--date=short") + .arg("--format=%H %h %cd") + .output() + { + Ok(output) if output.status.success() => output, + _ => return, + }; + let stdout = String::from_utf8(output.stdout).unwrap(); + let mut parts = stdout.split_whitespace(); + let mut next = || parts.next().unwrap(); + println!("cargo:rustc-env=RA_COMMIT_HASH={}", next()); + println!("cargo:rustc-env=RA_COMMIT_SHORT_HASH={}", next()); + println!("cargo:rustc-env=RA_COMMIT_DATE={}", next()) +} diff --git a/packages/cli/docs/.gitignore b/packages/cli/docs/.gitignore new file mode 100644 index 000000000..7585238ef --- /dev/null +++ b/packages/cli/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/packages/cli/docs/book.toml b/packages/cli/docs/book.toml new file mode 100644 index 000000000..c5c216fe4 --- /dev/null +++ b/packages/cli/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["YuKun Liu"] +language = "en" +multilingual = false +src = "src" +title = "Dioxus Cli" diff --git a/packages/cli/docs/src/SUMMARY.md b/packages/cli/docs/src/SUMMARY.md new file mode 100644 index 000000000..b5e3b91ae --- /dev/null +++ b/packages/cli/docs/src/SUMMARY.md @@ -0,0 +1,18 @@ +# Summary + +- [Introduction](./introduction.md) +- [Installation](./installation.md) +- [Create a Project](./creating.md) +- [Configure Project](./configure.md) +- [Commands](./cmd/README.md) + - [Build](./cmd/build.md) + - [Serve](./cmd/serve.md) + - [Clean](./cmd/clean.md) + - [Translate](./cmd/translate.md) +- [Plugin Development](./plugin/README.md) + - [API.Log](./plugin/interface/log.md) + - [API.Command](./plugin/interface/command.md) + - [API.OS](./plugin/interface/os.md) + - [API.Directories](./plugin/interface/dirs.md) + - [API.Network](./plugin/interface/network.md) + - [API.Path](./plugin/interface/path.md) \ No newline at end of file diff --git a/packages/cli/docs/src/cmd/README.md b/packages/cli/docs/src/cmd/README.md new file mode 100644 index 000000000..dae226577 --- /dev/null +++ b/packages/cli/docs/src/cmd/README.md @@ -0,0 +1,26 @@ +# Commands + +In this chapter we will introduce all `dioxus-cli` commands. + +> You can also use `dioxus --help` to get cli help info. + +``` +dioxus +Build, bundle, & ship your Dioxus app + +USAGE: + dioxus [OPTIONS]