Skip to content

Commit f82ffe5

Browse files
authored
small docs fixes (#48)
1 parent f6e3689 commit f82ffe5

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

website/content/docs/manual-install.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ cargo new my-website --bin
1010
cd my-website
1111
```
1212

13-
Next, add Maudit as a dependency in your `Cargo.toml` file, or run `cargo add maudit` to do so automatically:
13+
Next, add Maudit as a dependency in your `Cargo.toml` file, or run `cargo add maudit` to do so automatically. You might also want to add [Maud](https://maud.lambda.xyz/) as a dependency if you plan to use it for templating.
1414

1515
```toml
1616
[dependencies]
1717
maudit = "0.6"
18+
maud = "0.27" # optional
1819
```
1920

2021
Voilà! You can now use Maudit in your project. Check out the rest of the [documentation](/docs) for more information on how to use Maudit, or if you prefer jumping straght into the code, take a look at the [examples](https://github.com/bruits/maudit/tree/main/examples) and the [API documentation](https://docs.rs/maudit).

website/content/docs/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ section: "getting-started"
55

66
In this guide, you'll learn how to create a Maudit website and the general basis of Maudit in a few minutes of reading.
77

8-
If you prefer to read more detailed explanations, including exploration of various Maudit concepts, please read the [the tutorial]().
8+
If you prefer to read more detailed explanations, including exploration of various Maudit concepts, please read the [core concepts](/docs/content/).
99

1010
**This guide assumes that you have Rust installed and are familiar with the terminal.**
1111

@@ -72,7 +72,7 @@ use maudit::{coronate, routes, content_sources, BuildOptions, BuildOutput};
7272

7373
fn main() -> Result<BuildOutput, Box<dyn std::error::Error>> {
7474
coronate(
75-
routes![Index],
75+
routes![HelloWorld],
7676
content_sources![],
7777
BuildOptions::default()
7878
)

0 commit comments

Comments
 (0)