diff --git a/docs/Chirpy.md b/docs/Chirpy.md new file mode 100644 index 0000000..c24b55f --- /dev/null +++ b/docs/Chirpy.md @@ -0,0 +1,16 @@ +### First working version +- Create new repo using [chirpy starter template](https://github.com/cotes2020/chirpy-starter) +- Name the new repository `.github.io` +- In config file change URL to `https://username.github.io` +- Git action will automatically publish your repo to this url + +### For local build +- Clone to local repo folder +- In Gem file change wdm version to 0.2.0 due to error during `bundle install` +- `bundle install` to install theme and all plugins +- `bundle exec jekyll s` to build generate new version and start local server + +### Resources +- [chirpy](https://chirpy.cotes.page/posts/getting-started/) +- [How to build your Blog for free on GitHub Pages using Jekyll](https://www.youtube.com/watch?v=m1RYsmOMPLs) +- [Create a Digital Garden using Jekyll and GitHub Pages](https://www.youtube.com/watch?v=fX8d3SgdTbo) \ No newline at end of file diff --git a/docs/Setup.md b/docs/Setup.md index 45c0725..a0a81a2 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -29,6 +29,7 @@ - `bundle exec jekyll server` to build new website, here we are using bundle exec only for first time - `jekyll build` Builds the site and outputs a static site to a directory called _site. - `jekyll serve` Does jekyll build and runs it on a local web server at http://localhost:4000, rebuilding the site any time you make a change. +- `bundle install` to install new gem, for new theme or plugins ### GitHub Repo Setup - So basically there's 3 main folder