Gitlanding helps you create a beautiful landing page for your GitHub projects in three simple steps:
- Start from a blank React App on a branch of your repository.
- Import some
gitlanding
components. - Auto deploy with GitHub Actions, host it using GitHub page!
Don't worry, you will be guided every step of the way with specific instruction for MacOS, Widows and Linux.
Setting up a GitLanding page is also a great practical introduction to GitHub Actions and GitHub page.
Motivation
There is no shortage of website generators that enable the creation of decent-looking landing pages.
The problem, however, is that if your project grows you will eventually need to incorporate
features like internationalisation, routing, and other functionalities that your website generator
mat not be able to accommodate.
The approach of gitlanding
is to provide a library of customisable React component
designed to be fitting budding blocks for a landing page.
This way your little landing page is a react project capable of growing into a more mature project if need be.
You can have both a landing page (e.g.:
www.your-project.dev
) and a documentation website (e.g.:docs.your-project.dev
).
For creating documentation website GitBook is better fit than Gitlanding. GitBook is free for open source
projects (you just need to issue a request).
Showcase
Websites using gitlanding.
π Quick start
Heads over to the documentation website π!
Top comments (0)