DEV Community

Siddhant Khare
Siddhant Khare

Posted on

How to create an GitHub Special Repository for Organisation

Around a Year Ago, GitHub Releases a special feature, that we can create our README, which will show us to the GitHub Profile, like this:

image

And, Today I saw this tweet, that this feature is available for the Organisations too.

Now, let me show how you can create one for your GitHub organisation.

Steps to Create a homepage for GitHub organisation

  • Create a New Public Repository in your organization named .github.

  • Under That Make a profile directory

  • Add a README.md under profile directory.

The Path of your README.md should be .github/profile/README.md.

Things You can add in Your Org. Homepage

It Can have all your README Details as you had in README.md of your main repository of the Org.

Or, you can add some promotional stuff, as you have in your Organisation's Landing Page/ Documentation Page.

Example

  • You Have To Create A File Like This:

image

Open Given File

  • You Can Add All Information, you wanted to display it out there, ( it can work as your Promotional page also :) )

Sample:

<p align="center"><a href="https://iosf.in/" target="_blank"><img src="https://raw.githubusercontent.com/IndianOpenSourceFoundation/iosf-website/f38cba6cdba11cdcb90641ac192d1a36d67b6cd8/public/img/iosf-logo.svg" width="20%"></a></p>

<h1 align="center">Indian Open Source Foundation</h1>
<h2 align="center">Promoting open source, one step at a time smiley 😀 👨‍💻</h2>

> Join us as a contributor and associate with us in our journey for making Open Source Contribution lit <span role="img" aria-label="fire emoji">🔥</span> and super powerful for the budding and already existing community.

<p align="center"><a href="https://toolsiosf.typeform.com/to/fl45kmgs" target="_blank"><img src="https://img.shields.io/badge/-Join%20Us-%23EF233C" width="10%"></a>  <a href="https://twitter.com/iosf_india" target="_blank"><img src="https://badgen.net/badge/icon/twitter?icon=twitter&label" width="13%"></a> </p>



### Below is a list of the most important repositories.

- [Dynamic Cli](https://github.com/IndianOpenSourceFoundation/dynamic-cli): A Modern, user-friendly command-line HTTP client for the API testing, and if you're stuck - Search and browse StackOverflow without leaving the CLI.
- [Argon](https://github.com/IndianOpenSourceFoundation/Argon): A Website that will track the website traffic and health.
Enter fullscreen mode Exit fullscreen mode
  • Commit Your Changes and 💥

It Will Look Like this:
image

You Can Join Our Organisation Too :)

You Can Follow Me On:

Discussion (0)