docs icon indicating copy to clipboard operation
docs copied to clipboard

Update testing-your-github-pages-site-locally-with-jekyll.md

Open g-nitin opened this issue 1 year ago â€ĸ 4 comments

Why:

Some users set their baseurl in _config.yml to match their GitHub Pages URL structure. This can cause problems when previewing the site locally. The added information provides a simple solution without requiring changes to the configuration file.

Closes: #34181

What's being changed (if available, include any code snippets, screenshots, or gifs):

This PR adds information about running Jekyll locally when the _config.yml file has a baseurl set to the GitHub repository's link. The changes include:

  1. A new command bundle exec jekyll serve --baseurl="" to run Jekyll locally without modifying the _config.yml file.
  2. A brief explanation of when and why to use this command.

These additions will help users who encounter issues with local preview due to baseurl conflicts, improving the local development experience for GitHub Pages sites.

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

g-nitin avatar Aug 02 '24 16:08 g-nitin

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 02 '24 16:08 welcome[bot]

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar Aug 02 '24 16:08 github-actions[bot]

@g-nitin Thanks so much for opening a PR! I'll get this triaged for review ✨

nguyenalex836 avatar Aug 02 '24 18:08 nguyenalex836

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Aug 05 '24 07:08 github-actions[bot]

@g-nitin Thank you for committing the suggestion! 💛 I'll update the branch and get this merged once tests are passing 🍏

nguyenalex836 avatar Aug 13 '24 18:08 nguyenalex836

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Aug 13 '24 18:08 github-actions[bot]


seikh-web avatar Aug 14 '24 12:08 seikh-web

__

seikh-web avatar Aug 14 '24 12:08 seikh-web