simple-gh-pages-theme 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f74777454e6c817541ffd856c597ceb29108fcfc2ca2e1ff8710929e5b12a8
-  data.tar.gz: f4bef2936b68df0052a2622e161eacfb0ae5e510eb2c37d1054bd9c4d097ec00
+  metadata.gz: f5144f620dc2053c7cb8f8edeee17d6c2a5f2d85ac1105802515b6a5c5d8aea5
+  data.tar.gz: 83bf55b657497ff342992c50c899deb474163cb748aada682c65b3c5de0af5b6
 SHA512:
-  metadata.gz: cf6ba10ddddb570f4422e031bc33b48ce886e053c059d7375042a9c5c97a557ed32b6f81205b57cb015208b309c9ca2d0c7b07873479f357d0ca868bc0a9cc43
-  data.tar.gz: f3d8f92f9537a48deaff67323120ef1975e07b3c14bba368fd277d9f1142194f1da9767add52ba3ac1d812314818d22aeff59f0b3d3794c3b6fc37d774e398a6
+  metadata.gz: c6c392ca3aa4cc855bd4c3e21b39b3ea1977492d54618c94e08b51055527941398721b6723d52c1ab16e17d31c4610dd0cc4626b554c0a31bb3900a21c1b1f59
+  data.tar.gz: 5820facac70b0de40e32b5b4e9498ccf0fdb096e728813fc02e55f157695feec3ac8e52776409773707a3e3dcaecac9befc552d57573170942a469a900c3f462

data/README.md

@@ -2,7 +2,7 @@
 
 <table>
 <tr><td>
-<img width="500" alt="empty default" src="https://user-images.githubusercontent.com/5443727/229302809-750132e5-d461-4ec8-a38a-ccdc62b3b72e.png"> 
+<img width="500" alt="after installing the theme" src="https://user-images.githubusercontent.com/5443727/229901057-23be4caa-0c70-46c1-aa83-d60cbb1220ba.png">
 </td><td>
 <img width="500" alt="jordiwippert.nl" src="https://user-images.githubusercontent.com/5443727/229302812-d481eb40-b0ca-49cd-95d5-c7fef5228b7a.png">
 </td>
@@ -17,66 +17,62 @@ in-use: https://jordiwippert.nl
 </table>
 
 ## Quick installation
-
-1. Add this line to your Jekyll site's `Gemfile`:
-
+```shell
+# 0. To create a new Jekyll site:
+jekyll new <SITENAME>
+cd <SITENAME>
+```
 ```ruby
+# 1. Add this line to your Jekyll site's `Gemfile`:
 gem "simple-gh-pages-theme"
 ```
-
-2. Add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
-
 ```yaml
+# 2. Add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
 theme: simple-gh-pages-theme
 ```
-
-3. And then execute:
-
 ```shell
+# 3. Execute on your command line:
 bundle
-```
 
-4. Run install script to create 'posts.md'
-
-```shell
+# 4. Run install script to create 'posts.md'
 bundle exec install-theme
-```
 
-5. When you now run your website locally on `http://localhost:4000`, it should show the theme:
-
-```shell
+# 5. When you now run your website locally on `http://localhost:4000`, it should show the theme:
 bundle exec jekyll serve
 ```
 
 ## Configuration:
 
-See/use example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/example-config.yml). Copy to `_config.yml`
+All configuration options that can be overwritten can be found [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/_config.yml).
 
-## Usage
+## Github Pages setup
 
-### Posts
-
-Create your posts like:
+Go to `settings` > `page` in your github-pages-repository.
+1. Select source: `Deploy from a branch`
+2. Select branch: `gh-pages` (create if non-existent)
+3. Select `/docs` as folder
+4. You can now run `script/deploy`
 
+## Posts
+Create your posts (files) like:
 ```
-docs/_posts/published/yyyy-mm-dd-postname.md
+docs/_posts/yyyy-mm-dd-postname.md
 ```
 
-Each post can have the following options (with defaults):
-
-```
-layout:     post
-title:      "Title here"
-image:      assets/images/image.png OR https://example.com/image.png
-categories: [category]
-tags:       [tag]
-highlight:  false (if true: it will be used on about page, more here)
-short:      false (if true: it shown in 'short' list on home page)
+Each post can have the following (metadata) options (with example values):
+```yaml
+layout:     post                    # OR page
+title:      "Title here"            # Used for post-titles
+image:      assets/images/image.png # OR images on urls like: https://example.com/image.png
+categories: [category]              # 'category' can be anything
+tags:       [tag]                   # 'tag' can be everything
+highlight:  false                   # if true: it will listed in highlights, which can be shown with: `{% include highlights.html %}`
+short:      false                   # if true: it shown in 'short' list on home page
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lvenl/simple-gh-pages-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/LiveNL/simple-gh-pages-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 ## License
 

data/bin/install-theme

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 # Create 'posts.md'
 File.write('posts.md', <<~HEREDOC
   ---
@@ -6,3 +8,59 @@ File.write('posts.md', <<~HEREDOC
   ---
   HEREDOC
 )
+
+if !Dir.exist?("docs")
+  Dir.mkdir("docs")
+end
+
+Dir.glob("*").each do |file|
+  next if file == ".gitignore" || file == "docs"
+  if File.directory?(file)
+    FileUtils.mkdir_p("docs/#{file}")
+    FileUtils.cp_r("#{file}/.", "docs/#{file}/")
+    FileUtils.rm_rf(file)
+  else
+    FileUtils.mv(file, "docs/#{file}")
+  end
+end
+
+# Create 'script/deploy'
+if !Dir.exist?("script")
+  Dir.mkdir("script")
+end
+
+File.write('script/deploy', <<~HEREDOC
+  #!/bin/bash
+
+  MAIN_BRANCH="main"
+  DEPLOY_BRANCH="gh-pages"
+
+  # Clear files in deploy_branch
+  git checkout $DEPLOY_BRANCH
+  rm -r docs
+
+  # Get docs-files/folders from main_branch
+  git checkout $MAIN_BRANCH -- docs
+  cd docs || exit
+
+  # Build _site contents
+  bundle exec jekyll build
+  cd .. || exit
+
+  # Delete everything except for the docs/_site folder
+  find docs -mindepth 1 -maxdepth 1 ! -name '_site' -exec rm -r {} +
+
+  # Move all files in docs/_site to the docs folder
+  mv docs/_site/* docs
+
+  # Create commit with last message from main_branch and commit to deploy_branch
+  git add .
+  COMMIT_MESSAGE=$(git log $DEPLOY_BRANCH -1 --pretty="%h %s")
+  git commit -m "$COMMIT_MESSAGE"
+  git push origin $DEPLOY_BRANCH
+  git checkout $MAIN_BRANCH
+  HEREDOC
+)
+
+
+File.chmod(0777, "script/deploy")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-gh-pages-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - LiveNL
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-archives
@@ -85,7 +85,8 @@ files:
 homepage: https://github.com/LiveNL/simple-gh-pages-theme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: https://github.com/LiveNL/simple-gh-pages-theme
 post_install_message:
 rdoc_options: []
 require_paths: