Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: config for windows machine #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: config for windows machine #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins
gem "webrick" if Gem.win_platform?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

webrick also needs to be added here for other OSes (confirmed on my Mac + macOS Big Sur 11.5.2)

Suggested change
gem "webrick" if Gem.win_platform?
gem "webrick"


gem "tzinfo-data"
gem "wdm", "~> 0.1.0" if Gem.win_platform?
Expand Down
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,26 @@ Contains basic configuration to get you a site with:

Replace sample content with your own and [configure as necessary](https://mmistakes.github.io/minimal-mistakes/docs/configuration/).


## Setup Instruction

1. Clone the repo or download the source code to your local box.
2. Install dependencies run `bundle install`
3. Go to `_config.yml` & Change the repository name to your GitHub repo name `repository: "githubUser/RepoName"`
4. Serve your project `bundle exec jekyll serve`
5. Visit your site http://127.0.0.1:4000


---



## Troubleshooting

If you have a question about using Jekyll, start a discussion on the [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll). Other resources:

- [Ruby 101](https://jekyllrb.com/docs/ruby-101/)
- [Setting up a Jekyll site with GitHub Pages](https://jekyllrb.com/docs/github-pages/)
- [Configuring GitHub Metadata](https://github.com/jekyll/github-metadata/blob/master/docs/configuration.md#configuration) to work properly when developing locally and avoid `No GitHub API authentication could be found. Some fields may be missing or have incorrect data.` warnings.


2 changes: 2 additions & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ twitter_username: username
github_username: username
minimal_mistakes_skin: default
search: true
# Change the repository name
repository: "mmistakes/minimal-mistakes"

# Build settings
markdown: kramdown
Expand Down