source code = website!
Build a website for your software projects with one command.
When you run landr on your local repository, it gathers info by leveraging standard conventions.
It'll first look for a git remote from
github.com and retrieve some basic information about your project from the github api (
releases), it will then parse standard files like
/docs, it'll then use the data to build out beautiful pages for your website.
This allows the maintenance of your website to be a side effect of keeping your software project inline with standard github conventions.
npm i -g landr
From the root of your local
.git repo run:
prefixPaths flag is useful when deploying to gh-pages where you need the
landr build --prefixPaths
Deploy to github pages:
I know, we said there is zero configuration, but there are some cases where configuration is necessary for example if you need to add analytics tokens, or ignore certain files.
landr allows configuration via a
landr.conf.js file the repository root it must export a config object.
// landr.conf.jsmoduleexports =analytics:mixpanel: <mixpanel-id>googleAnalytics: <ga-id>
You have to maintain your source code why maintain a website too?
As a software company we have a growing number of websites to build and maintain. We built landr so we could focus on our projects and not their websites.
Most OS websites the same, the have a hero, a getting started and some docs. There is definitely room for automation.
Get to work. 👷
Landr is free software, and may be redistributed under the terms specified in the license.