Github Readme Syntax

Article version: GitHub.com

You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.

Centering and aligning images in GitHub readmes using the deprecated HTML align attribute: This works in any GitHub.md markdown file, such as a GitHub readme.md file. It relies on the deprecated HTML align attribute, but still works fine. GitHub.com Enterprise Server 3.0 Enterprise Server 2.22 Enterprise Server 2.21 GitHub AE See all Enterprise releases Organizing information with tables You can build tables to organize information in comments, issues, pull requests, and wikis.

You can add a README file to a repository to communicate important information about your project. A README, along with a repository license, contribution guidelines, and a code of conduct, communicates expectations for your project and helps you manage contributions.

For more information about providing guidelines for your project, see 'Adding a code of conduct to your project' and 'Setting up your project for healthy contributions.'

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

What the project does
Why the project is useful
How users can get started with the project
Where users can get help with your project
Who maintains and contributes to the project

If you put your README file in your repository's root, docs, or hidden .github directory, GitHub will recognize and automatically surface your README to repository visitors. Skin pack 1 ps3.

If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page. You can edit your profile README with GitHub Flavored Markdown to create a personalized section on your profile. For more information, see 'Managing your profile README.'

Section links in README files and blob pages

Many projects use a table of contents at the start of a README to direct users to different sections of the file. You can link directly to a section in a rendered file by hovering over the section heading to expose the link:

Relative links and image paths in README files

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this: