gitlanding

✒️ Showcase your open source project with a good-looking webpage ✒️

Home - Components - Documentation

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 GNU/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 i18n, routing, and other functionalities that your website generator may 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.

• Gitlanding.dev itself
• SSPCloud.fr
• tss-react.dev
• keycloakify
• tsafe.dev

https://user-images.githubusercontent.com/6702424/148715912-64485db0-ae26-474f-a6ce-b9a142a419e0.mp4

https://user-images.githubusercontent.com/6702424/148716227-4a699c07-ba17-4860-b4bb-9feeed8b7662.mp4

🚀 Quick start

Heads over to the documentation website 📙!

Dev

NOTE: These are the commands for contributing. If you just want to start using GitLanding it's here

git clone https://github.com/thieryw/gitlanding && cd gitlanding
yarn install
yarn build
# To start the test project
yarn start_vanilla

Edit the file in src/test/vanilla/src/index.tsx to experiments with the components.

Testing your changes in an external app (that uses yarn)

You have made some changes to the code and you want to test them in your app before submitting a pull request?

Assuming you/my-app have gitlanding as a dependency.

cd ~/github
git clone https://github.com/you/my-app
cd my-app
yarn

cd ~/github
git clone https://github.com/thieryw/gitlanding
cd #{REPO_NAME}#
yarn
yarn build
yarn link-in-app my-app
npx tsc -w

# Open another terminal

cd ~/github/my-app
rm -rf node_modules/.cache
yarn start # Or whatever my-app is using for starting the project

You don't have to use ~/github as reference path. Just make sure my-app and gitlanding are in the same directory.