Gankra / oranda

🎁 generate beautiful landing pages for your developer tools

Home Page:https://opensource.axo.dev/oranda/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

oranda

🎁 generate beautiful landing pages for your projects

crates.io CI release web

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.

oranda uses oranda so you can checkout a live example here!

Installation

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

Quickstart

# 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

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!

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:

"artifacts": {
    "cargo_dist": true
}

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

About

🎁 generate beautiful landing pages for your developer tools

https://opensource.axo.dev/oranda/

License:Apache License 2.0


Languages

Language:Rust 63.5%Language:CSS 19.1%Language:JavaScript 12.0%Language:Handlebars 4.5%Language:Nix 1.0%