simple-gh-pages-theme 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed0b3abadfdeb7321a6a2efaf687b91e36b5ce1161799c695f2b20246ee99d6
-  data.tar.gz: 3814d56bf98da478731ed1d9fea3b9dd537ff178f731e9424a50c40220e67339
+  metadata.gz: b7b807d8c650f10418abcc0c706ffd1c650507409b2ef50a4a6f278333a22622
+  data.tar.gz: 973d492bd1fa490a39071abfbc1bcbd1454caa6064be5f62194c99d3e8b84d9d
 SHA512:
-  metadata.gz: 8775ea0c3b815ff9b9bfaade1ee8f493682f727ec7974b5c78797c12d3114b7475bb224e36e20bf5d355c0da94ca0d2c91252e7f1314ded89b1d565bf05dee5a
-  data.tar.gz: d1e3e7b58deccf8cad9450589da09d4f54709a18b03e81ab5ae91781b8b3c79ccd7675204e66d0abb4c4f1f19002bade4da1396e39fc79de03352c6acd91f2e9
+  metadata.gz: 47549fede30cf7138a9393174e48757585a4d96d1fa79eee44ef12dfa30945cd028b1f95388e42861106d42238a6fe09c41ef25fcae0040af9deb9928c7f893d
+  data.tar.gz: ce01829d02aa82aa0abc54af35291121ac55c47239824ade736ce189a75a480b5dc3a352a514ce98286f8895c7e72f3d5dbf9743f3fd5beee058439fbcc2eed8

data/README.md

@@ -1,49 +1,74 @@
 # simple-gh-pages-theme
 
+<table>
+<tr><td>
+<img width="500" alt="empty default" src="https://user-images.githubusercontent.com/5443727/229302809-750132e5-d461-4ec8-a38a-ccdc62b3b72e.png"> 
+</td><td>
+<img width="500" alt="jordiwippert.nl" src="https://user-images.githubusercontent.com/5443727/229302812-d481eb40-b0ca-49cd-95d5-c7fef5228b7a.png">
+</td>
+<tr>
+<td>
+simple-gh-pages-theme, after install and first post setup                            
+</td>
+<td>
+in-use
+</td>
+</tr>
+</table>
+
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
-
 ```ruby
 gem "simple-gh-pages-theme"
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
-
+And add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
 ```yaml
 theme: simple-gh-pages-theme
 ```
 
 And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install simple-gh-pages-theme
-
+```shell
+bundle
+OR
+gem install simple-gh-pages-theme
+```
 ### !!! Important. To make the layouts work properly.
 
 If you created a new website (`jekyll new sitename`), you can make your pages use the layout by changing:
 
-- **index.markdown**: to `layout: index`
-- **posts.markdown**: to `layout: posts` (file might not exist yet)
-- **404.markdown**: to `layout: 404` (file might not exist yet)
-
-Like:
-
+- **index.markdown**: 
 ```
 ---
 layout: index
 ---
 ```
+- **about.markdown**:
+```
+---
+layout: post
+permalink: /about.html 
+---
+```
+- **posts.markdown**: (file might not exist yet)
+```
+---
+layout: posts
+---
+```
+- **404.markdown**: (file might not exist yet)
+```
+---
+layout: 404
+---
+```
 
 ## Configuration:
 
-See example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/_config.yml)
+See/use example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/example-config.yml). Copy to `_config.yml`
 
 ## Usage
-
 ### Posts
 
 Create your posts like:
@@ -65,18 +90,18 @@ short:      false (if true: it shown in 'short' list on home page)
 list_post:  false (if true: it shown in list on home/posts 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.
-
 ## Development
 
 To set up your environment to develop this theme, run `bundle install`.
 
-Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+
+This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
 
 When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `simple-gh-pages-theme.gemspec` accordingly.
+
+## 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.
 
 ## License
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-gh-pages-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - LiveNL
@@ -61,7 +61,6 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- _config.yml
 - _data/navigation.yml
 - _includes/highlights.html
 - _includes/intro.html

data/_config.yml

@@ -1,60 +0,0 @@
-theme: simple-gh-pages-theme
-title: My website
-description: The website description
-domain: "username.github.io"
-baseurl: "https://example.com"
-url: "https://example.com"
-gtag: "G-XXXXXXXXX" (your google tag)
-
-about:
-  name: Firstname Lastname
-  site: "https://example.com"
-  avatar: assets/images/image.png
-  email: example@example.com
-  socials:
-    twitter: https://twitter.com/example
-    linkedin: https://www.linkedin.com/in/example/
-    github: https://github.com/example
-    keybase: https://keybase.io/example
-    medium: https://medium.com/@example
-    stack-overflow: https://stackoverflow.com/users/xxxxxx/example
-
-plugins:
-  - jekyll-archives
-  - jekyll-redirect-from
-  - jekyll-sitemap
-
-jekyll-archives:
-  enabled:
-    - tags
-    - categories
-  layout: category-posts
-  permalinks:
-    year: "/:year/"
-    month: "/:year/:month/"
-    day: "/:year/:month/:day/"
-    tag: "/tag/:name/"
-    category: "/category/:name/"
-
-defaults:
-  - scope:
-      path: "assets/**"
-    values:
-      sitemap: false
-
-sass:
-  sass_dir: _sass
-
-# Excluded items can be processed by explicitly listing the directories or
-# their entries' file path in the `include:` list.
-exclude:
-  - .sass-cache/
-  - .jekyll-cache/
-  - gemfiles/
-  - Gemfile
-  - Gemfile.lock
-  - node_modules/
-  - vendor/bundle/
-  - vendor/cache/
-  - vendor/gems/
-  - vendor/ruby/