From ac808d31ad9609ae5a6029ef5f13ff38f470d820 Mon Sep 17 00:00:00 2001 From: YuKun Liu <41265098+mrxiaozhuox@users.noreply.github.com> Date: Sun, 20 Feb 2022 18:23:11 +0800 Subject: [PATCH] docs: add `cli` docs --- docs/cli/src/SUMMARY.md | 4 +++- docs/cli/src/configure.md | 30 ++++++++++++++++++++++++++++++ docs/cli/src/creating.md | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 docs/cli/src/configure.md create mode 100644 docs/cli/src/creating.md diff --git a/docs/cli/src/SUMMARY.md b/docs/cli/src/SUMMARY.md index 6d47af5eb..115a0992d 100644 --- a/docs/cli/src/SUMMARY.md +++ b/docs/cli/src/SUMMARY.md @@ -1,4 +1,6 @@ # Summary - [Introduction](./introduction.md) -- [Installation](./installation.md) \ No newline at end of file +- [Installation](./installation.md) +- [Create a Project](./creating.md) +- [Configure Project](./configure.md) \ No newline at end of file diff --git a/docs/cli/src/configure.md b/docs/cli/src/configure.md new file mode 100644 index 000000000..11ccd6a16 --- /dev/null +++ b/docs/cli/src/configure.md @@ -0,0 +1,30 @@ +# Configure Project + +This chapter will introduce `Dioxus.toml` and anatomy the config file. + +## Structure + +We use `toml` to define some info for `dioxus` project. + +### Application + +1. ***name*** - project name & title +2. ***default_platform*** - which platform target for this project. + ``` + # current support: web, desktop + # default: web + default_platform = "web" + ``` + change this to `desktop`, the `dioxus build & serve` will default build desktop app. +3. ***out_dir*** - which directory to put the output file; use `dioxus build & service`, the output will put at this directory, and the `assets` will be also copy to here. + ``` + out_dir = "dist" + ``` +4. ***asset_dir*** - which direcotry to put your `static, assets` file, cli will automatic copy all file to `out_dir`, so you can put some resource file in there, like `CSS, JS, Image` file. + ``` + asset_dir = "public" + ``` + +### Web.App + +1. ***title*** - this value will display on the web page title. like `` tag. \ No newline at end of file diff --git a/docs/cli/src/creating.md b/docs/cli/src/creating.md new file mode 100644 index 000000000..fa725a4f7 --- /dev/null +++ b/docs/cli/src/creating.md @@ -0,0 +1,38 @@ +# Create a Project + +Once you have the Dioxus CLI tool installed, you can use it to create dioxus project. + +## Initializing a default project + +The `dioxus create` command will create a new directory containing a project template. +``` +dioxus create hello-dioxus +``` + +It will clone a default template from github template: [DioxusLabs/dioxus-template](https://github.com/DioxusLabs/dioxus-template) + +> This default template is use for `web` platform application. + +then you can change the current directory in to the project: + +``` +cd hello-dioxus +``` + +> Make sure `wasm32 target` is installed before running the Web project. + +now we can create a `dev server` to display the project: + +``` +dioxus serve +``` + +by default, the dioxus dev server will running at: [`http://127.0.0.1:8080/`](http://127.0.0.1:8080/) + +## Initalizing from other repository + +you can assign which repository you want to create: + +``` +dioxus init hello-dioxus --template=gh:dioxuslabs/dioxus-template +``` \ No newline at end of file