aboutsummaryrefslogtreecommitdiff
path: root/docs/pages
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-06-15 00:42:19 +0800
committer魏曹先生 <1992414357@qq.com>2026-06-15 00:42:19 +0800
commitb944b00207161ae271143cabbbe73cd146a0b5d3 (patch)
tree071a789a906ece6ec88db981e315e3847ed5acc8 /docs/pages
parente214d07f6783009869c93bbab1e4bec9829584ee (diff)
Fix trailing whitespace in documentation files
Diffstat (limited to 'docs/pages')
-rw-r--r--docs/pages/2-getting-started.md16
-rw-r--r--docs/pages/other/features.md34
2 files changed, 25 insertions, 25 deletions
diff --git a/docs/pages/2-getting-started.md b/docs/pages/2-getting-started.md
index 77503e9..35da464 100644
--- a/docs/pages/2-getting-started.md
+++ b/docs/pages/2-getting-started.md
@@ -6,7 +6,7 @@
cargo new my-cli
cd my-cli
```
-
+
## Add Dependency
Add the following to `Cargo.toml`:
@@ -16,7 +16,7 @@ Add the following to `Cargo.toml`:
version = "0.2"
features = []
```
-
+
## Enable Features
**Mingling** has all features disabled by default and does not provide an all-in-one feature like `full`.
@@ -31,7 +31,7 @@ features = [
"comp",
]
```
-
+
> [!NOTE]
> Visit [docs.rs](https://docs.rs/mingling/latest/mingling/feature/index.html) or [Features](pages/other/features) to learn about all available features.
@@ -41,22 +41,22 @@ Edit `src/main.rs` with the following code:
```rust
use mingling::prelude::*;
-
+
fn main() {
let mut program = ThisProgram::new();
-
+
program.exec_and_exit();
}
-
+
gen_program!();
```
-
+
## Verify Compilation
```plaintext
~# cargo check
```
-
+
---
Once everything is good, start building!
diff --git a/docs/pages/other/features.md b/docs/pages/other/features.md
index 8f458af..f0edc84 100644
--- a/docs/pages/other/features.md
+++ b/docs/pages/other/features.md
@@ -19,15 +19,15 @@ Enables async runtime support, allowing `#[chain]` to bind `async` functions, e.
```rust
// Features: ["async"]
-
+
pack!(StateFoo = ());
-
+
#[chain]
async fn handle_state_foo(foo: StateFoo) -> Next {
StateFoo::new(())
}
```
-
+
See [example](https://mingling-rs.github.io/mingling/docs/example-viewer.html?name=example-async-support)
## Feature `builds`
@@ -41,13 +41,13 @@ Enables scripts needed for use in `build.rs`, currently including:
```rust
// Features: ["builds", "comp"]
use mingling::build::build_comp_scripts;
-
+
fn main() {
// Generate completion scripts for `myprogram`
build_comp_scripts("myprogram").unwrap();
}
```
-
+
## Feature `clap`
**Description:**
@@ -106,17 +106,17 @@ For example, allows the shorthand form `dispatcher!("greet")`, which auto-genera
```rust
// Features: ["extra_macros"]
-
+
pack!(StatePrev1 = ());
pack!(StatePrev2 = ());
-
+
pack!(StateNext = ());
-
+
#[chain]
fn handle_state_prev2(_p: StatePrev1) {
// A #[chain] with no return type can simply omit the return value
}
-
+
#[chain]
fn handle_state_prev1(_p: StatePrev1) -> Next {
let foo = 1;
@@ -129,19 +129,19 @@ fn handle_state_prev1(_p: StatePrev1) -> Next {
}
}
```
-
+
### `#[program_setup]`
```rust
// Features: ["extra_macros"]
use mingling::{macros::program_setup, Program};
-
+
fn main() {
let mut program = ThisProgram::new();
program.with_setup(NoErrorSetup);
program.exec_and_exit();
}
-
+
#[program_setup]
fn no_error_setup(program: &mut Program<ThisProgram>) {
program.global_flag(["--no-error"], |program| {
@@ -149,24 +149,24 @@ fn no_error_setup(program: &mut Program<ThisProgram>) {
});
}
```
-
+
### `entry!`
```rust
// Features: ["extra_macros"]
use mingling::macros::entry;
-
+
pack!(EntryHello = Vec<String>);
-
+
fn main() {
let result = handle_hello(entry!("--name", "Bob")).into();
// ... assertion logic here
}
-
+
#[chain]
fn handle_hello(args: EntryHello) {}
```
-
+
</details>
## Feature `general_renderer`