#Your docs in locations generator

If you want to use a static site generator other than Jekyll, we recommend that you write a GitHub Actions to build and publish your site instead. If you publish your site from a source branch, GitHub Pages will use Jekyll to build your site by default. For more information, see ' Configuring a publishing source for your GitHub Pages site.' GitHub provides starter workflows for several static site generators. If you use a custom build process or a static site generator other than Jekyll, you can write a GitHub Actions to build and publish your site. You can also customize your own build process locally or on another server. You can create your own static files or use a static site generator to build your site for you. GitHub Pages publishes any static files that you push to your repository. GitHub provides starter workflows for common publishing scenarios to help you write your workflow.įor more information, see ' Configuring a publishing source for your GitHub Pages site.' Static site generators If you want to use a build process other than Jekyll or you do not want a dedicated branch to hold your compiled static files, we recommend that you write a GitHub Actions workflow to publish your site. Whenever changes are pushed to the source branch, the changes in the source folder will be published to your GitHub Pages site. The source branch can be any branch in your repository, and the source folder can either be the root of the repository ( /) on the source branch or a /docs folder on the source branch. You can specify which branch and folder to use as your publishing source. If you do not need any control over the build process for your site, we recommend that you publish your site when changes are pushed to a specific branch. You can publish your site when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site. For more information, see ' About repositories.' If you have sensitive data in your site's repository, you may want to remove the data before publishing. Warning: GitHub Pages sites are publicly available on the internet, even if the repository for the site is private. Publishing sources for GitHub Pages sites Project sites, whether owned by an organization or a personal account, are unlimited. You can only create one user or organization site for each account on GitHub. Unless you're using a custom domain, project sites are available at http(s)://.github.io/ or http(s)://.github.io/.įor more information about how custom domains affect the URL for your site, see ' About custom domains and GitHub Pages.' The source files for a project site are stored in the same repository as their project. Unless you're using a custom domain, user and organization sites are available at http(s)://.github.io or http(s)://.github.io. To publish an organization site, you must create a repository owned by an organization that's named. To publish a user site, you must create a repository owned by your personal account that's named. User and organization sites are connected to a specific account on. Project sites are connected to a specific project hosted on GitHub, such as a JavaScript library or a recipe collection. There are three types of GitHub Pages sites: project, user, and organization. For more information, see ' Managing the publication of GitHub Pages sites for your organization.' Types of GitHub Pages sites Organization owners can disable the publication of GitHub Pages sites from the organization's repositories. To get started, see ' Creating a GitHub Pages site.' Organizations that use GitHub Enterprise Cloud can also publish sites privately by managing access control for the site.įor more information, see ' Changing the visibility of your GitHub Pages site' in the GitHub Enterprise Cloud documentation. You can create GitHub Pages sites that are publicly available on the internet. For more information, see ' Configuring a custom domain for your GitHub Pages site.'

You can host your site on GitHub's github.io domain or your own custom domain. You can see examples of GitHub Pages sites in the GitHub Pages examples collection. GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.

Your docs in locations