Giter Club home page Giter Club logo

oranda's Introduction

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.

oranda's People

Contributors

saravieira avatar ashleygwilliams avatar gankra avatar sarahghp avatar proofconstruction avatar msfjarvis avatar tshepang avatar dependabot[bot] avatar gd0st avatar shadows-withal avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.