docs: add commands
This commit is contained in:
1 parent
ff92b10055
commit
9fb5019929
5 files changed
+177
-1
No files matched your search
@@ -3,4 +3,7 @@
|
|||||||
- [Introduction](./introduction.md)
|
- [Introduction](./introduction.md)
|
||||||
- [Installation](./installation.md)
|
- [Installation](./installation.md)
|
||||||
- [Create a Project](./creating.md)
|
- [Create a Project](./creating.md)
|
||||||
- [Configure Project](./configure.md)
|
- [Configure Project](./configure.md)
|
||||||
|
- [Commands](./cmd/README.md)
|
||||||
|
- [Build](./cmd/build.md)
|
||||||
|
- [Serve](./cmd/serve.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] <SUBCOMMAND>
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
-h, --help Print help information
|
||||||
|
-v Enable verbose logging
|
||||||
|
|
||||||
|
SUBCOMMANDS:
|
||||||
|
build Build the Rust WASM app and all of its assets
|
||||||
|
clean Clean output artifacts
|
||||||
|
config Dioxus config file controls
|
||||||
|
create Init a new project for Dioxus
|
||||||
|
help Print this message or the help of the given subcommand(s)
|
||||||
|
serve Build, watch & serve the Rust WASM app and all of its assets
|
||||||
|
translate Translate some source file into Dioxus code
|
||||||
|
```
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
# Build
|
||||||
|
|
||||||
|
`dioxsu build` command can help you `pack & build` a dioxus project.
|
||||||
|
|
||||||
|
```
|
||||||
|
dioxus-build
|
||||||
|
Build the Rust WASM app and all of its assets
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
dioxus build [OPTIONS]
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
--example <EXAMPLE> [default: ""]
|
||||||
|
--platform <PLATFORM> [default: "default_platform"]
|
||||||
|
--release [default: false]
|
||||||
|
```
|
||||||
|
|
||||||
|
you can use this command to build project to `out_dir` :
|
||||||
|
|
||||||
|
```
|
||||||
|
dioxus build --release
|
||||||
|
```
|
||||||
|
|
||||||
|
## Target platform
|
||||||
|
|
||||||
|
use option `platform` choose build target platform:
|
||||||
|
|
||||||
|
```
|
||||||
|
# for desktop project
|
||||||
|
dioxus build --platform desktop
|
||||||
|
```
|
||||||
|
|
||||||
|
`platform` only supports `desktop` & `web`.
|
||||||
|
|
||||||
|
```
|
||||||
|
# for web project
|
||||||
|
dioxus build --platform web
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build Example
|
||||||
|
|
||||||
|
you can use `--example {name}` to build a example code.
|
||||||
|
|
||||||
|
```
|
||||||
|
# build `example/test` code
|
||||||
|
dioxus build --exmaple test
|
||||||
|
```
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# Serve
|
||||||
|
|
||||||
|
`dioxsu serve` can start a dev server (include hot-reload tool) to run the project.
|
||||||
|
|
||||||
|
```
|
||||||
|
dioxus-serve
|
||||||
|
Build, watch & serve the Rust WASM app and all of its assets
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
dioxus serve [OPTIONS]
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
--example <EXAMPLE> [default: ""]
|
||||||
|
--platform <PLATFORM> [default: "default_platform"]
|
||||||
|
--release [default: false]
|
||||||
|
```
|
||||||
|
|
||||||
|
you can use this command to build project and start a `dev server` :
|
||||||
|
|
||||||
|
```
|
||||||
|
dioxus serve
|
||||||
|
```
|
||||||
|
|
||||||
|
## Target platform
|
||||||
|
|
||||||
|
use option `platform` choose build target platform:
|
||||||
|
|
||||||
|
```
|
||||||
|
# for desktop project
|
||||||
|
dioxus serve --platform desktop
|
||||||
|
```
|
||||||
|
|
||||||
|
`platform` only supports `desktop` & `web`.
|
||||||
|
|
||||||
|
`dev-server` only for `web` project.
|
||||||
|
|
||||||
|
```
|
||||||
|
# for web project
|
||||||
|
dioxus serve --platform web
|
||||||
|
```
|
||||||
|
|
||||||
|
## Serve Example
|
||||||
|
|
||||||
|
you can use `--example {name}` to start a example code.
|
||||||
|
|
||||||
|
```
|
||||||
|
# build `example/test` code
|
||||||
|
dioxus serve --exmaple test
|
||||||
|
```
|
||||||
@@ -94,3 +94,54 @@ Only include resources at `Dev` mode.
|
|||||||
"https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.js"
|
"https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.js"
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Config example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[application]
|
||||||
|
|
||||||
|
# App (Project) Name
|
||||||
|
name = "{{project-name}}"
|
||||||
|
|
||||||
|
# Dioxus App Default Platform
|
||||||
|
# desktop, web, mobile, ssr
|
||||||
|
default_platform = "web"
|
||||||
|
|
||||||
|
# `build` & `serve` dist path
|
||||||
|
out_dir = "dist"
|
||||||
|
|
||||||
|
# resource (public) file folder
|
||||||
|
asset_dir = "public"
|
||||||
|
|
||||||
|
[web.app]
|
||||||
|
|
||||||
|
# HTML title tag content
|
||||||
|
title = "dioxus | ⛺"
|
||||||
|
|
||||||
|
[web.watcher]
|
||||||
|
|
||||||
|
# when watcher trigger, regenerate the `index.html`
|
||||||
|
reload_html = true
|
||||||
|
|
||||||
|
# which files or dirs will be watcher monitoring
|
||||||
|
watch_path = ["src", "public"]
|
||||||
|
|
||||||
|
# include `assets` in web platform
|
||||||
|
[web.resource]
|
||||||
|
|
||||||
|
# CSS style file
|
||||||
|
style = []
|
||||||
|
|
||||||
|
# Javascript code file
|
||||||
|
script = []
|
||||||
|
|
||||||
|
[web.resource.dev]
|
||||||
|
|
||||||
|
# serve: [dev-server] only
|
||||||
|
|
||||||
|
# CSS style file
|
||||||
|
style = []
|
||||||
|
|
||||||
|
# Javascript code file
|
||||||
|
script = []
|
||||||
|
```
|
||||||
Reference in new issue
Block a user