oranda 0.3.0

🎁 generate beautiful landing pages for your projects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

<div class="oranda-hide">

# oranda


</div>

> 🎁 generate beautiful landing pages for your projects

[![crates.io](https://img.shields.io/crates/v/oranda.svg)](https://crates.io/crates/oranda)
[![CI](https://github.com/axodotdev/oranda/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/axodotdev/oranda/actions/workflows/ci.yml)
[![release](https://github.com/axodotdev/oranda/actions/workflows/release.yml/badge.svg)](https://github.com/axodotdev/oranda/actions/workflows/release.yml)
[![web](https://github.com/axodotdev/oranda/actions/workflows/web.yml/badge.svg?branch=main)](https://github.com/axodotdev/oranda/actions/workflows/web.yml)


`oranda` is an opinionated static-site generator that is designed for developers
who are publishing projects and would like a website but don't want to build
one from scratch.

<div class="oranda-hide">

`oranda` uses `oranda` so you can checkout a live example [here][website]!

## Installation


To install `oranda`, please visit the [`oranda` website][website]- which is generated by
`oranda`!

[website]: https://axodotdev.github.io/oranda

</div>

## Quickstart


```sh
# build your site

> oranda build

# start a server to checkout a local version of your built site in a browser

> oranda serve

# build your site and start a server that rebuilds on file changes

> oranda dev
```

Here's an animated demo:

![oranda demo gif](https://github.com/axodotdev/oranda/assets/6445316/439082a6-2caa-477e-93cc-1ff985d9bb21)

## Configuration

If you'd like to configure `oranda`, place an `oranda.json` file in the root of
your project and fill it with the configuration you'd like. Check out the [docs]
to learn more about your configuration options!

[docs]: https://opensource.axo.dev/oranda/book/configuration.html

## Installers: integrating with `cargo-dist`

`oranda` is built to work alongside [`cargo-dist`], which is a tool that builds
distributable artifacts for your Rust applications. To tell `oranda` you are
using `cargo-dist` you can add this to your `oranda.json`:

```json
"artifacts": {

    "cargo_dist": true
}
```

This will link `oranda` and `cargo-dist` such that `oranda` can display your
installers and downloadable artifacts on your page.

[`cargo-dist`]: https://github.com/axodotdev/cargo-dist