Skip to content

docs: expand readme with a quick start #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aureliendossantos wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: expand readme with a quick start #89

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0a2c78
docs: expand readme with a quick start
aureliendossantos Jan 24, 2026
bcede23
docs: simplified readme
aureliendossantos Jan 24, 2026
fa70d20
docs: fix readme wording
aureliendossantos Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 41 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,58 @@
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/bruits/maudit)
[![Discord](https://img.shields.io/discord/1323452220817014876)](https://maudit.org/chat/)

A library for generating static websites with Rust.
[Maudit](https://maudit.org) is a library for generating static websites with Rust.

## Getting started

The quickest way to get started is with the Maudit CLI:

```bash
cargo install maudit-cli
```

Create a new project by running:

```bash
maudit init
```

You can also use Maudit without the CLI tool, or integrate Maudit into an existing project. Check out our [Manual Installation](/docs/manual-install) guide.

## Commands

Start a local dev server with live reload:

```bash
maudit dev
```

Build your project to the `dist` directory:

```bash
maudit build
```

Preview your build before deploying:

```bash
maudit preview
```

## Quick links

🌍 Visit our [website](https://maudit.org) to read the [documentation](https://maudit.org/docs) and our [news](https://maudit.org/news)
🌍 Visit our [website](https://maudit.org) to read the [documentation](https://maudit.org/docs) and the latest [news](https://maudit.org/news)

📦 See the [crate](https://crates.io/crates/maudit) on Crates.io, and the [reference](https://docs.rs/maudit/latest/maudit/) on Docs.rs.

🐛 [Report a bug](https://github.com/bruits/maudit/issues), please read our [contributing guidelines](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/bruits/maudit/blob/main/CODE_OF_CONDUCT.md) first.
🐛 [Report a bug](https://github.com/bruits/maudit/issues). Please read our [contributing guidelines](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/bruits/maudit/blob/main/CODE_OF_CONDUCT.md) first.

💬 Join the discussion on [Github](https://github.com/bruits/maudit/discussions) and [Discord](https://maudit.org/chat/), if you have any questions, ideas, or suggestions.

## Contributing

Contributions are welcome! See our [Contributor Guide](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) for help getting started.

# License
## License

Maudit is licensed under [the MIT License](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for details.
Maudit is licensed under the [MIT License](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for details.
Loading