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.

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

Configuration updates #21

Merged
merged 4 commits into from
Feb 5, 2019

Conversation

infotexture
Copy link
Contributor

This PR tweaks a few settings in the configuration:

  • add a Gemfile to permit builds on hosts that do not infer dependencies (like Netlify)
  • exclude unnecessary files from the conversion to keep the generated _site folder clean
  • switch Markdown parser for better compatibility with recent Jekyll versions as run on GitHub Pages

This change allows Jekyll to build presentation content outside the GitHub Pages environment, for example on Netlify.

Per https://www.netlify.com/blog/2017/05/11/migrating-your-jekyll-site-to-netlify

> If you have generated your Jekyll site using GitHub pages or forked a template there is a good chance you do not have a Gemfile. This is because GitHub pages will infer dependencies for you. If you would like to build your project outside of GitHub a Gemfile is needed and simple to create.
> Starting May 1st, 2016, GitHub Pages will only support kramdown, Jekyll’s default Markdown engine
– https://github.blog/2016-02-01-github-pages-now-faster-and-simpler-with-jekyll-3-0

GitHub Pages currently runs on Jekyll 3.7.4:
https://pages.github.com/versions
@dploeger
Copy link
Owner

dploeger commented Feb 5, 2019

Thanks for this. 🎁

About the Markdown engine switch: Does that impose any breaking changes? If so, I would release it as a major version.

@mrmanc
Copy link
Collaborator

mrmanc commented Feb 5, 2019

I was about to create a PR to add a docker-compose file to make running locally easier. Does that impact this at all?

@infotexture
Copy link
Contributor Author

The kramdown parser bills itself as supporting a superset of Markdown constructs handled by other engines, so if anything, is should handle more things gracefully, not less.

I don't think it's necessarily a breaking change, so I'm not sure this alone would warrant a major version bump, but if you include #22, you might want to do that anyway.

@infotexture
Copy link
Contributor Author

I was about to create a PR to add a docker-compose file to make running locally easier.

Guess it depends whether people are more likely to already have Docker available locally, or a local Jekyll install. In the latter case, running this is as simple as cloning & jekyll serve.

But adding a Docker file wouldn't hurt and might be handy for those that know what to do with it.

@dploeger
Copy link
Owner

dploeger commented Feb 5, 2019

Great, I'm merging this and #22 and will release it as a major. Thanks, guys.

@dploeger dploeger merged commit 4d3b2d4 into dploeger:master Feb 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants