GitHub Pages
Effortlessly host your website directly from GitHub
About GitHub Pages
GitHub Pages enables you to publish websites straight from your GitHub repository. With seamless editing and instant updates, it's ideal for personal sites, project documentation, and portfolios.
FAQ
To set up a GitHub Pages site, create a new public repository named username.github.io, where username is your GitHub username or organization name. Then clone the repository, add an index.html file, and push your changes to the main branch. Your site will be live at https://username.github.io.
Yes, you can use a custom domain by creating a file named CNAME in your repository and including your URL in it. For more details, refer to the GitHub Pages documentation on custom URLs.
GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's plans.
Jekyll is a static site generator with built-in support for GitHub Pages. You can configure Jekyll settings by editing your _config.yml file. Jekyll supports Markdown and Liquid templating. For more details, see the Jekyll documentation.
Yes, GitHub Pages supports certain plugins by default, such as jekyll-coffeescript and jekyll-gist. You can enable additional plugins by adding them to the plugins setting in your _config.yml file. However, unsupported plugins will not work on GitHub Pages.
You can test your site locally by building it with Jekyll before pushing changes to GitHub. This allows you to preview your changes before they go live. For more information, see Testing your GitHub Pages site locally with Jekyll.
You can add a theme to your GitHub Pages site by editing your _config.yml file or by using the theme chooser in the GitHub Pages section of your repository settings. For more details, see Adding a theme to your GitHub Pages site using Jekyll.
A user/organization site is hosted at https://username.github.io, where username is your GitHub username or organization name. A project site is hosted at https://username.github.io/repository, where repository is the name of your project repository. You get one user/organization site per GitHub account and organization, and unlimited project sites.
Alternatives to consider
See all alternatives
Badges
Promote GitHub Pages giving it more exposure, by adding these badges to your website, documentation, or product listing. Each badge links back to GitHub Pages page on Webfolio.
<a href="https://www.webfolio.to/tools/github-pages?utm_source=badge&utm_campaign=badge" target="_blank" rel="noopener noreferrer"><img src="https://www.webfolio.to/badges/featured_color.svg" alt="Featured on Webfolio" style="max-width: 150px" /></a>
Categories
Claim this tool
Are you the founder? Claim your profile to update details and track views.