You can build your GitHub Pages site locally to preview and test changes to your site.
Who can use this feature?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.
Anyone with read permissions for a repository can test a GitHub Pages site locally.
PrerequisitesBefore you can use Jekyll to test a site, you must:
We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:
Open TerminalTerminalGit Bash.
Navigate to the publishing source for your site. For more information, see Configuring a publishing source for your GitHub Pages site.
Run bundle install
.
Run your Jekyll site locally.
$ bundle exec jekyll serve
> Configuration file: /Users/octocat/my-site/_config.yml
> Source: /Users/octocat/my-site
> Destination: /Users/octocat/my-site/_site
> Incremental build: disabled. Enable with --incremental
> Generating...
> done in 0.309 seconds.
> Auto-regeneration: enabled for '/Users/octocat/my-site'
> Configuration file: /Users/octocat/my-site/_config.yml
> Server address: http://127.0.0.1:4000/
> Server running... press ctrl-c to stop.
Note
If you've installed Ruby 3.0 or later (which you may have if you installed the default version via Homebrew), you might get an error at this step. That's because these versions of Ruby no longer come with webrick
installed.
To fix the error, try running bundle add webrick
, then re-running bundle exec jekyll serve
.
If your _config.yml
file's baseurl
field contains your GitHub repository's link, you can use the following command when building locally to ignore that value and serve the site on localhost:4000/
:
bundle exec jekyll serve --baseurl=""
To preview your site, in your web browser, navigate to http://localhost:4000
.
Note
While the github-pages
gem remains supported for some workflows, GitHub Actions is now the recommended approach for deploying and automating GitHub Pages sites.
Jekyll is an active open source project that is updated frequently. If the github-pages
gem on your computer is out of date with the github-pages
gem on the GitHub Pages server, your site may look different when built locally than when published on GitHub. To avoid this, regularly update the github-pages
gem on your computer.
github-pages
gem.
bundle update github-pages
.gem update github-pages
.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4