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

Add Stackbit Integration #208

Merged
merged 9 commits into from Sep 19, 2019

Conversation

@JugglerX
Copy link
Contributor

commented Aug 28, 2019

Prerequisites

Put an x into the box(es) that apply:

  • This pull request fixes a bug.
  • [x ] This pull request adds a feature.
  • This pull request introduces breaking change.

Description

This pull request add's Stackbit to this Hugo theme. It add's the stackbit.yaml file which makes this theme work with several headless CMS automatically (including Forestry, NetlifyCMS, DatoCMS & Contentful) and it deploys the site to Netlify in 1 click.

You can try it out: https://app.stackbit.com/create?theme=https://github.com/stackbithq/hugo-coder (note the "create with stackbit" button in the readme will import the theme from your repo so until the PR is merged it wont work)

Issues Resolved

List any existing issues this pull request resolves.

Checklist

Put an x into the box(es) that apply:

General

  • Add stackbit.yaml file which makes the theme work with Stackbit.
  • Updated 2 posts changing math and katex from string values to booleans

Resources

  • If you have changed any SCSS code, run make release to regenerate all CSS files

Contributors

  • Add yourself to CONTRIBUTORS.md if you aren't on it already
@luizdepra

This comment has been minimized.

Copy link
Owner

commented Aug 30, 2019

We'll need to add every possible configuration into stackbit.yaml? Because there some missing, also Hugo has many other confiurations.

@JugglerX

This comment has been minimized.

Copy link
Contributor Author

commented Sep 2, 2019

Which configuration options are missing? Do you mean supporting uncommented options in the config? Or do you mean supporting undeclared default hugo params in the config? I can make both work, but typically you don't need to support the default hugo params.

@JugglerX

This comment has been minimized.

Copy link
Contributor Author

commented Sep 16, 2019

Anything I can do here to progress this PR?

@luizdepra

This comment has been minimized.

Copy link
Owner

commented Sep 17, 2019

Do you mean supporting uncommented options in the config? Or do you mean supporting undeclared default hugo params in the config?
Both I think. If the user will need one or more configurations not declared in the stackbit.yam, what she/he will need to do to use the configuration?

I just don't get the usage here. The stackbit.yaml file is just a base for demo deploy on Stackbit or it is used to configure a new sites? The users will need to copy this file into their site repo?

@JugglerX

This comment has been minimized.

Copy link
Contributor Author

commented Sep 19, 2019

It let's people use this theme with Stackbit. It will clone this theme, connect it to any headless CMS and deploy it to Netlify.

best thing is to just try it: https://app.stackbit.com/create?theme=https://github.com/stackbithq/hugo-coder

If it still doesn't make sense or you don't see the value then you can close this PR out. Not a problem.

@luizdepra

This comment has been minimized.

Copy link
Owner

commented Sep 19, 2019

I see the value here, but I wanted to make sure that stackbit.yaml must be added to this repo. Now I understand.

I will approve this PR now. But, because I don't use stackbit, if some issue come up in the future I will mention you to help, ok?

@luizdepra luizdepra merged commit 3cc2397 into luizdepra:master Sep 19, 2019
2 of 5 checks passed
2 of 5 checks passed
Header rules No header rules processed
Details
Pages changed 90 new files uploaded
Details
Redirect rules No redirect rules processed
Details
Mixed content No mixed content detected
Details
deploy/netlify Deploy preview ready!
Details
@JugglerX

This comment has been minimized.

Copy link
Contributor Author

commented Sep 23, 2019

Thanks for merging!

Sure, If people create issues related to Stackbit I'll be happy to put in fixes. If it becomes too difficult to "support", all you need to do is remove the stackbit.yaml file. The integration is really easy to remove and doesn't effect your existing theme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.