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

Readme - Quick Installation using GitHub template repository instead of forking #32

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Zo-Bro-23
Copy link

I made a GitHub template repository for moonwalk (here) which makes quick start a lot easier if you're working mainly from GH Pages instead of locally. This PR updates the readme for better getting started instructions regarding this.

@Zo-Bro-23
Copy link
Author

PS: The other commits showed up because I messed up my branches. The "Files changed" shows only the readme, which is the only thing this PR changes.

@abhinavs
Copy link
Owner

Thanks a lot for this - can you please add these instructions in github_pages.md file instead of README.md

@Zo-Bro-23
Copy link
Author

Done!

However, don't you think more people will be using GitHub Pages than local development? Those using GitHub Pages will likely be more inexperienced than those looking for local development, so maybe you should consider adding the GH Pages instructions in the README and moving the local instructions to a separate file. Having them both together is fine too. It's your decision though!

@Zo-Bro-23
Copy link
Author

Also, I removed the instructions about GH Branches and Soopr SEO Tag.

Soopr seems to work fine with GH Pages. Those who've worked with GH Pages will already know about branches, and those who haven't will find it much easier for follow the step-by-step instructions. Let me know if you want me to add it back though.

@abhinavs
Copy link
Owner

I'm sorry to be a bit slow with my responses. I promise to take a look at all the pull requests you have contributed in a couple of weeks.

Thanks again for your contributions. I appreciate them.

@abhinavs
Copy link
Owner

To answer your questions

  1. A lot of people (including me) use Netlify/Vercel for deploying static websites
  2. jekyll-soopr-seo-tag plugin didn't work by default with gh-pages, hence I added the disclaimer. Will check it again when I take a look at the template and try it.

Thanks a lot

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.

2 participants