landr
Generate great websites for your projects with zero configuration
Last updated 6 days ago by balena.io .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install landr 
SYNC missed versions from official npm registry.

Landr

GitHub license npm version PRs Welcome

Generate great websites for your projects with zero configuration.

Landr is alpha software and its under heavy development, so various things might be broken in the best case!

Highlights

  • Functional Websites: Landr renders your project and its documentation in a gorgeous and UX friendly way to your end users, in the best possible way while you focus on shipping features
  • Follows OSS Conventions: Landr understands most common repository conventions, and makes use of them fully. Build a great repository and get a great website for it. Its a win-win
  • Fully Automatic: Landr requires no configuration at all. It is smart enough to figure out what it needs on its own. Point it to a repository, hold tight, and let Landr do its magic

Installation

  1. Install the Landr CLI:

    npm install --global landr
    
  2. Go to a Balena CI powered repo:

    cd path/to/repository
    
  3. Generate your website:

    landr
    

Head over to our docs!

Motivation

Creating a website for a project is hard and time-consuming. Yet, a great website is one of the best ways to promote a project. Landr aims to capture our experience presenting a wide variety of open source projects on the web, so that having a website that can compete with your favourite massively popular open source project is not only possible, but comes with zero overhead.

Examples

The Landr website is of course based on Landr! You may also enjoy the following sites:

  • Etcher - Flash OS images to SD cards & USB drives, safely and easily
  • BalenaFin - A board for fleet owners
  • BalenaOS - A host OS tailored for containers, designed for reliability, proven in production
  • OpenBalena - Open source software to manage connected IoT devices
  • BalenaEngine - A container engine built for IoT

Do you know of any Landr website we missed? Let us know!

Getting Help

If you're having any problem, please raise an issue on GitHub and the Landr team will be happy to help.

Contributing

Do you want to help make Landr better? Take a look at our Contributing Guide. Hope to see you around!

License

Landr is free software, and may be redistributed under the terms specified in the license.

Current Tags

400 Versions

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 35,336
Last Day 0
Last Week 35,336
Last Month 119,756
Dependencies (37)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |