landr
Generate great websites for your projects with zero configuration
Last updated 12 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.

Usage

$ npm install -g landr
$ landr COMMAND
running command...
$ landr (-v|--version|version)
landr/5.31.6 linux-x64 node-v12.15.0
$ landr --help [COMMAND]
USAGE
  $ landr COMMAND
...

Commands

landr build

Build a static site using landr

USAGE
  $ landr build

OPTIONS
  -d, --deploy         Deploy the site to netlify after generating it
  -m, --meta=meta      The location of the meta file used to generate your landr site
  -o, --output=output  The output directory where we should generate your landr site
  -v, --verbose        Run in verbose mode

DESCRIPTION
  Build a static site using landr into a local directory.
  By default this command will look for a meta.json file in the current directory
  to use as data for generating the site. The location of the data file can be
  specified using the -m flag.
  By default the site will be written to a folder named landr-dist in the current
  directory. Ther location that the site will be written to can be specified using
  the -o flag.
  You can also optionally deploy your site to netlfiy using the -d flag. Deploying
  to netlify relies on providing the NETLIFY_AUTH_TOKEN env var.

See code: lib/cli/commands/build.js

landr help [COMMAND]

display help for landr

USAGE
  $ landr help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

landr meta

Generate a meta file

USAGE
  $ landr meta

OPTIONS
  -o, --output=output  The output path where the metadata should be written

DESCRIPTION
  Generate a meta file that contains all the information landr needs to generate a site.

See code: lib/cli/commands/meta.js

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

474 Versions

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 7
Last Month 178,516
Dependencies (50)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |