Skip to content

Commit

Permalink
new Docs added for chirpy theme
Browse files Browse the repository at this point in the history
  • Loading branch information
vivekkpatel committed Nov 6, 2024
1 parent 6217e2e commit 5219ef4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/Chirpy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### First working version
- Create new repo using [chirpy starter template](https://github.com/cotes2020/chirpy-starter)
- Name the new repository `<username>.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)
1 change: 1 addition & 0 deletions docs/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5219ef4

Please sign in to comment.