How to get tabs in my project readme section #86658
Replies: 3 comments 6 replies
-
You need to have all required documents files like - MyRepository
- README.md
- LICENSE
- CODE_OF_CONDUCT.md
- docs
- installation.md
- usage.md once you have all you will see option to show it in tabs Organize these files in your GitHub repository: README: The README file is the default landing page for your repository. LICENSE: To add a license to your repository, create a file named LICENSE in the root directory. CODE_OF_CONDUCT: If you want to include a code of conduct in your repository, create a file named CODE_OF_CONDUCT.md in the root directory. Other Custom Tabs: If you want to create additional tabs like "Documentation," "Changelog," or anything else, organize your content into directories and create Markdown files. For example, you might create a folder named docs and place files like installation.md and usage.md inside. GitHub will automatically create a "Docs" tab. Remember to commit and push these files to your GitHub repository. After doing so, GitHub will recognize these special files and display the corresponding tabs on the repository page. Hope this is what you were looking for. |
Beta Was this translation helpful? Give feedback.
-
Hey guys, These are called "default community health files" and are apparently placed inside
or inside special Take a look at SO response here. Also some documentation here. The list is always changing, and this is the current extract from the documentation:
|
Beta Was this translation helpful? Give feedback.
-
These don't necessarily correspond to tabs though, e.g. on https://github.com/Shopify/ruby-lsp we have a |
Beta Was this translation helpful? Give feedback.
-
Select Topic Area
Question
Body
I'm seeing some projects that have some new tabs like https://github.com/google/cadvisor
Beta Was this translation helpful? Give feedback.
All reactions