Improve CLI docs (#1404)
* Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
This commit is contained in:
1 parent
a0d1e5de3a
commit
94f76946fc
20 files changed
+308
-488
No files matched your search
+41
-15
@@ -1,43 +1,69 @@
|
||||
<div align="center">
|
||||
<h1>📦✨ Dioxus CLI </h1>
|
||||
<div style="text-align: center">
|
||||
<h1>📦✨ Dioxus CLI</h1>
|
||||
<p><strong>Tooling to supercharge Dioxus projects</strong></p>
|
||||
</div>
|
||||
**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.
|
||||
|
||||
The **dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running.
|
||||
It handles all building, bundling, development and publishing to simplify development.
|
||||
|
||||
## Installation
|
||||
|
||||
### Install stable version
|
||||
### Install the stable version (recommended)
|
||||
|
||||
```
|
||||
cargo install dioxus-cli
|
||||
```
|
||||
### Install from git repository
|
||||
|
||||
### Install the latest development build through git
|
||||
|
||||
To get the latest bug fixes and features, you can install the development version from git.
|
||||
However, this is not fully tested.
|
||||
That means you're probably going to have more bugs despite having the latest bug fixes.
|
||||
|
||||
```
|
||||
cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli
|
||||
```
|
||||
|
||||
This will download the CLI from the master branch,
|
||||
and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).
|
||||
|
||||
### Install from local folder
|
||||
```
|
||||
cargo install --path . --debug
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
||||
## Get Started
|
||||
|
||||
Use `dx create project-name` to initialize a new Dioxus project. <br>
|
||||
|
||||
Use `dx create project-name` to initialize a new Dioxus project.
|
||||
It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository.
|
||||
|
||||
<br>
|
||||
|
||||
Alternatively, you can specify the template path:
|
||||
|
||||
```
|
||||
dx create hello --template gh:dioxuslabs/dioxus-template
|
||||
```
|
||||
|
||||
## Dioxus Config File
|
||||
Run `dx --help` for a list of all the available commands.
|
||||
Furthermore, you can run `dx <command> --help` to get help with a specific command.
|
||||
|
||||
Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature.
|
||||
## Dioxus config file
|
||||
|
||||
You can get more configure information from [Dioxus CLI Document](https://dioxuslabs.com/cli/configure.html).
|
||||
You can use the `Dioxus.toml` file for further configuration.
|
||||
Some fields are mandatory, but the CLI tool will tell you which ones are missing.
|
||||
You can create a `Dioxus.toml` with all fields already set using `dx config init project-name`,
|
||||
or you can use this bare-bones template (only mandatory fields) to get started:
|
||||
```toml
|
||||
[application]
|
||||
name = "project-name"
|
||||
# Currently supported platforms: web, desktop
|
||||
default_platform = "web"
|
||||
|
||||
[web.app]
|
||||
title = "Hello"
|
||||
|
||||
[web.watcher]
|
||||
|
||||
[web.resource.dev]
|
||||
```
|
||||
|
||||
The full anatomy of `Dioxus.toml` is shown on the [Dioxus website](https://dioxuslabs.com/learn/0.4/CLI/configure).
|
||||
Reference in new issue
Block a user