Update template (#6)

* build: ignore vendor bundle * feat: add font-awesome-svg icon * fix: smaller icons * fix: jekyll configuration see https://jekyllrb.com/docs/troubleshooting/#configuration-problems * Adds default value to `hidden` property for posts All pages with layout `post` are given a property `hidden` with default value of `false`. The value can be overwritten in the front matter of a specific post that you might want to set to hidden. Why? After PR sergiokopplin#278 no navigation links were shown unless posts had explicitly been specified as not hidden (`hidden: false`). This PR is meant to fix this issue. * Fixing invalid date in the YAML front matter error Fixing `does not have a valid date in the YAML front matter` error while building the site. More info: sergiokopplin#348. * Added info on running this site in Docker * Fixing an issue with og:image for posts Fixing an issue where all links will be shown with the site's image, instead of the image specified in the `image` field in the specific post's front matter. More info: sergiokopplin#350 * add logic to show external image for about page * exclude vendor folder found via jekyll/jekyll#5267 (comment) * Improving quality and performance by using online tests * Only bake icons to html if they are being used I kept the Twitter and Facebook ones unconditionally because they may also be used on the author page. I recognize that there is no `site.google-plus` variable, but this at least guarantees that this icon will never appear unless the user really wants it. * upgrade to jekyll-paginate-v2 * feat: css improvements Thanks to @cbrueffer (cbrueffer@ae9e470) * Updating normalize.scss to the last version * Fixing variable name in sass file * bugfix unrecongnized Liquid tag 'fa_svg' * 🐛 Fix Icon Size * 🐛 Fix Icon Color on Share Component * 🐛 Fix URLS with https * 🐛 Fix Travis htmlproofer runner config * Build site with GitHub actions (sergiokopplin#426) * test deploy * typo * docs: wip * test * remove DEPLOY_TOKEN, use GITHUB_TOKEN instead * use github token * try to trigger Github actions * Update README.md * Update README.md * testing * fix: removes Fontawesome (sergiokopplin#435) * fix: https on all links & removes github workflow (sergiokopplin#436) * fix: https on all links & removes github workflow * fix: removes brokwn html-proofer * fix: updates test pipeline * fix(socials): change linkedin's href value (sergiokopplin#437) If you try to use linkedin without www in front of it, it throws `Hmm. We’re having trouble finding that site.` on Firefox. * fix: site urls * Use 'post' class even if there are no tags (sergiokopplin#441) Co-authored-by: Andrés Maldonado <amaldona@etu.utc.fr> * Improve inline code CSS formatting (sergiokopplin#445) I added a grey box and centered (vertical-align: middle) the inline code. This inline formatting is similar to the GitHub line formatting. I left the multiline CSS intact. * feat: adds dark theme (sergiokopplin#484) * feat: adds dark theme * chore: updates screen shot * docs: updates * Add `rel="noopener"` to social links (sergiokopplin#481) To improve performance and prevent security vulnerabilities. * feat: dark theme as default * feat: adds dark syntax theme * feat: handles font weight on dark theme * fix: removes social link hover feature * fix: disqus username * fix: removes unused social links * fix: removes piwik * fix: removes travis ci * fix: removes config _dev * docs: removes nodejs from docs * docs: removes local config from docs * docs: removes travis from docs * Update _config.yml * feat: adds webrick gem * feat: adds fontawesome * chore: removes unused package jekyll mentions * Create CNAME * Delete CNAME * Create CNAME * Delete CNAME * fix: site title instead of site name * fix: removes jekyll-admin due to warning * fix: removes jekyll-admin due to warning * Added the missing close tags (sergiokopplin#489) * Added the missing close tags * Removed unnecessary files * fix rss feed invisible on dark mode (sergiokopplin#494) * Add option for auto theme switching depending on system preference. (sergiokopplin#497) * fix: removes pagination due to conflict * docs: adds docker * docs: updates docs * docs: updates * Update README.md (sergiokopplin#525) * docs: updates * docs: updates * docs: updates * chore: refactor font awesome load * fix: canonical issue * fix: acessilibity issue * fix: light theme acessibiliy issue * fix: acessiliby issue * fix: accessibility issue * fix: accessibility issue * fix: perf issue * fix: perf issues * fix: removes unused code * update x-twitter icon (sergiokopplin#526) update x-twitter icon * Create CONTRIBUTION.md (sergiokopplin#528) * Update CONTRIBUTION.md file (sergiokopplin#530) * added issues url (sergiokopplin#531) * Update about.md (sergiokopplin#533) fixed the typo error --------- Co-authored-by: Sylvain METAYER <contact@sylvainmetayer.fr> Co-authored-by: Rustam Mehmandarov <mehmandarov@users.noreply.github.com> Co-authored-by: c-ameron <pnzreba@gmail.com> Co-authored-by: Cristiano Nunes <cfgnunes@gmail.com> Co-authored-by: Matthew Thomas <macravin@gmail.com> Co-authored-by: Chirag Arora <me@chia.ro> Co-authored-by: Cristiano Nunes <cfgnunes@cefetmg.br> Co-authored-by: Sérgio A. Kopplin <sergiokopplin@gmail.com> Co-authored-by: kevche <kevche@umich.edu> Co-authored-by: Taylan Dogan <doganntaylan@gmail.com> Co-authored-by: am97 <amaldona@tutanota.com> Co-authored-by: Andrés Maldonado <amaldona@etu.utc.fr> Co-authored-by: Zach Zhao <Zachzhao@outlook.com> Co-authored-by: slashformotion <45801817+slashformotion@users.noreply.github.com> Co-authored-by: Mohammad Rezania <ash.wxrz@hotmail.com> Co-authored-by: Made Indra <made.indra@protonmail.com> Co-authored-by: Ricardo Rodrigues <ricardo.e.p.rodrigues@gmail.com> Co-authored-by: Adhika P <40765693+adhika16@users.noreply.github.com> Co-authored-by: XZM27 <55028818+Xzm27@users.noreply.github.com> Co-authored-by: Himanshu Kumar Mahto <93067059+HimanshuMahto@users.noreply.github.com> Co-authored-by: KRISH SONI <67964054+krishvsoni@users.noreply.github.com> Co-authored-by: chinmay7016 <75988613+chinmay7016@users.noreply.github.com>
timKraeuter · Nov 9, 2023 · c411bd1 · c411bd1
1 parent 20364e1
commit c411bd1
Show file tree

Hide file tree

Showing 48 changed files with 587 additions and 769 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/404.html b/404.html
@@ -6,9 +6,9 @@
 <section class="lost-container">
   <h1>Uh oh!</h1>
   <div class="link">
-    <img class="selfie" alt="{{ site.name }}" src="{{ site.url }}/assets/images/error.gif" />
+    <img class="selfie" alt="{{ site.title }}" src="{{ site.url }}/assets/images/error.gif" />
   </div>
   <br />
   <br />
   <a href="/">Take me home!</a>
-</section>
+</section>
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -0,0 +1,45 @@
+# Contributing to the Project
+Thank you for considering contributing to this project! We appreciate your interest and help in making this project better. Please take a moment to review the following guidelines to ensure a smooth contribution process.
+
+## Getting Started
+Before you start contributing, please check the [README](https://github.com/sergiokopplin/indigo#setup) for instructions on setting up the project.
+
+## Contribution Guidelines
+To contribute to this project, please follow these steps:
+
+### 1. Fork the Repository
+Click the "Fork" button at the top right of the repository to create a copy of this project in your own GitHub account. This will allow you to work on your changes without affecting the original repository.
+
+### 2. Clone Your Fork
+Use Git to clone your fork of the repository to your local machine. Replace `[your-username]` with your actual GitHub username.
+
+```bash
+git clone https://github.com/[your-username]/indigo.git
+```
+### 3. Create a New Branch
+Before making changes, create a new branch for your work. Naming your branch descriptively will help others understand its purpose.
+```bash
+git checkout -b my-feature-branch
+```
+### 4. Make Changes
+Make your changes or improvements to the project. Ensure your code follows the project's coding guidelines.
+
+### 5. Commit Your Changes
+After making your changes, commit them with a clear and concise message explaining the purpose of the commit.
+```bash
+git commit -m "Add new feature"  # Use a descriptive commit message
+```
+### 6. Push to Your Fork
+Push your changes to your forked repository on GitHub. This will update your branch with your latest commits.
+```bash
+git push origin my-feature-branch
+```
+### 7. Create a Pull Request
+Once you have pushed your changes to your fork, go to the original repository and click the "New Pull Request" button. Follow the instructions to create a pull request.
+
+### 8. Wait for Review
+A project maintainer will review your pull request. Please be patient during the review process, and be prepared to make additional changes if requested.
+
+### 9. Continuous Improvement
+Your contributions are valuable! By participating in this project, you help improve it for everyone. Thank you for your support and collaboration!
+If you encounter any issues or have questions, feel free to raise them by following the [Raise an issue](https://github.com/sergiokopplin/indigo/issues) process mentioned in the Contribution Guidelines.
diff --git a/FAQ.md b/FAQ.md
@@ -1,9 +1,10 @@
 # FAQ:
 
-- Article: How to Install Jekyll - by [Arti Annaswamy](https://github.com/aannasw). [Part 1](http://artiannaswamy.com/build-a-github-blog-part-1) and [Part 2](http://artiannaswamy.com/build-a-github-blog-part-2)
+- Article: How to Install Jekyll - by [Arti Annaswamy](https://github.com/aannasw). [Part 1](https://artiannaswamy.com/build-a-github-blog-part-1) and [Part 2](https://artiannaswamy.com/build-a-github-blog-part-2)
+- [How to build and run a Jekyll site in a Docker container](https://mehmandarov.com/disposable-docker-containers/)
 - [Emojis in the projects list?](https://github.com/sergiokopplin/indigo/issues/72)
 - [Nokogiri dependencie problems?](https://github.com/sergiokopplin/indigo/issues/81)
 - [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
-- [Tests with Travis CI - Tutorial](http://www.raywenderlich.com/109418/travis-ci-tutorial)
+- [Tests with Travis CI - Tutorial](https://www.raywenderlich.com/109418/travis-ci-tutorial)
 - [Why Sass?](https://github.com/sergiokopplin/indigo/issues/117)
 - [Jekyll Example](https://github.com/barryclark/jekyll-now) - how to clone, run and edit jekyll configs
diff --git a/Gemfile b/Gemfile
@@ -1,5 +1,11 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'github-pages'
-gem 'html-proofer'
-gem 'jekyll-admin'
+group :jekyll_plugins do
+    gem 'github-pages'
+    gem 'jekyll-feed'
+    gem 'jekyll-gist'
+    gem 'jekyll-seo-tag'
+    gem 'jemoji'
+end
+
+gem "webrick"
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-    <h2 align="center">Indigo Minimalist Jekyll Template - <a href="http://sergiokopplin.github.io/indigo/">Demo</a> · <a href="https://travis-ci.org/sergiokopplin/indigo"><img src="https://camo.githubusercontent.com/5393485b732749b3499264168fa8af60166071e8/68747470733a2f2f7472617669732d63692e6f72672f73657267696f6b6f70706c696e2f696e6469676f2e7376673f6272616e63683d67682d7061676573" alt="Build Status" data-canonical-src="https://travis-ci.org/sergiokopplin/indigo.svg?branch=gh-pages" style="max-width:100%;"></a></h2>
+    <h2 align="center">Indigo Minimalist Jekyll Template - <a href="https://sergiokopplin.github.io/indigo/">Demo</a></h2>
 </p>
 
 <p align="center">This is a simple and minimalist template for Jekyll for those who likes to eat noodles.</p>
@@ -16,52 +16,48 @@
     <b><a href="README.md#how-to">How to</a></b>
 </p>
 
+<p align="center">
+    Light and Dark themes.
+</p>
+
 <p align="center">
     <img src="https://raw.githubusercontent.com/sergiokopplin/indigo/gh-pages/assets/screen-shot.png" />
 </p>
 
 ## What has inside
 
-- [Jekyll](https://jekyllrb.com/), [Sass](http://sass-lang.com/) ~[RSCSS](http://rscss.io/)~ and [SVG](https://www.w3.org/Graphics/SVG/)
-- Tests with [Travis](https://travis-ci.org/)
-- Google Speed: [98/100](https://developers.google.com/speed/pagespeed/insights/?url=http%3A%2F%2Fsergiokopplin.github.io%2Findigo%2F);
-- No JS. :sunglasses:
+- [Jekyll](https://jekyllrb.com/), [Sass](https://sass-lang.com/) ~[RSCSS](https://rscss.io/)~ and [SVG](https://www.w3.org/Graphics/SVG/);
+- Page Speed: [99~Desktop](https://pagespeed.web.dev/analysis/https-sergiokopplin-github-io-indigo/41axptm3as?utm_source=psi&utm_medium=redirect&form_factor=desktop);
 
 ## Setup
 
 0. :star: to the project. :metal:
-2. Fork the project [Indigo](https://github.com/sergiokopplin/indigo/fork)
-3. Edit `_config.yml` with your data (check <a href="README.md#settings">settings</a> section)
-4. Write some posts :bowtie:
+1. Fork the project [Indigo](https://github.com/sergiokopplin/indigo/fork)
+2. Edit `_config.yml` with your data
+3. Write some posts :bowtie:
 
-If you want to test locally on your machine, do the following steps also:
+To run locally do the following:
 
-1. Install [Jekyll](http://jekyllrb.com), [NodeJS](https://nodejs.org/) and [Bundler](http://bundler.io/).
+1. Install [Jekyll](https://jekyllrb.com) and [Bundler](https://bundler.io/).
 2. Clone the forked repo on your machine
-3. Enter the cloned folder via terminal and run `bundle install`
-4. Then run `bundle exec jekyll serve --config _config.yml,_config-dev.yml`
-5. Open it in your browser: `http://localhost:4000`
-6. Test your app with `bundle exec htmlproofer ./_site`
-7. Do you want to use the [jekyll-admin](https://jekyll.github.io/jekyll-admin/) plugin to edit your posts? Go to the admin panel: `http://localhost:4000/admin`. The admin panel will not work on GitHub Pages, [only locally](https://github.com/jekyll/jekyll-admin/issues/341#issuecomment-292739469).
-
-## Settings
+3. Enter the cloned folder via terminal and run:
+```sh
+bundle install
+bundle exec jekyll serve
+```
+4. Open it in your browser: [http://localhost:4000](http://localhost:4000)
 
-You must fill some informations on `_config.yml` to customize your site.
+Or run with [docker](https://github.com/BretFisher/jekyll-serve).
 
-```
-name: John Doe
-bio: 'A Man who travels the world eating noodles'
-picture: 'assets/images/profile.jpg'
-...
+## Settings
 
-and lot of other options, like width, projects, pages, read-time, tags, related posts, animations, multiple-authors, etc.
-```
+You can customize your site on `_config.yml` file.
 
 ## How To?
 
-Check the [FAQ](./FAQ.md) if you have any doubt or problem.
+Check the [FAQ](./FAQ.md).
 
 ---
 ## License
 
-[MIT](http://kopplin.mit-license.org/) License © Sérgio Kopplin
+[MIT](https://kopplin.mit-license.org/) License © Sérgio Kopplin
diff --git a/Rakefile b/Rakefile
diff --git a/_config-dev.yml b/_config-dev.yml
diff --git a/_config.yml b/_config.yml
@@ -1,6 +1,6 @@
 # main text of home
-name: John Doe
-bio: A Man who travels the world eating noodles
+title: John Doe
+bio: A Person who travels the world eating noodles
 
 # twitter summary info
 description: A blog about technology and stuff related
@@ -10,71 +10,56 @@ description: A blog about technology and stuff related
 external-image: false
 picture: assets/images/profile.jpg
 
+# your site color theme, true for dark theme, 
+# false to light theme, auto to switch with system.
+dark-theme: auto
+
 # If you want to include your resume, set to true
 # and specify source (external or local).
 resume: true
 resume-external: true
 resume-url: https://google.com/?q=my+resume
 
-url: https://koppl.in/indigo
-# your url: http://USERNAME.github.io
+url: https://sergiokopplin.github.io/indigo
+# your url: https://USERNAME.github.io
 
 permalink: /:title/
 
 # To enable google analytics, supply your token below
 # analytics-google: 'UA-MYANALYTICS'
 
-# To enable piwik tracking, supply your url & site ID below
-# analytics-piwik-url: 'piwik.my-host.com'
-# analytics-piwik-id: 1
-
 # if you don't want comments in your posts, leave categories empty
 disqus:
-  shortname: mydisqus # enter this from your disqus account
+  shortname: github # enter this from your disqus account
   categories: [blog, project] # only show disqus for posts that have these categories
 
 # if you don't have any of social below, comment the line
 facebook: myfacebook
 twitter: mytwitter
-# instagram: myinstagram
-# pinterest: mypinterest
-# linkedin: mylinkedin
-# youtube: myyoutube
-# spotify: myspotify
+instagram: myinstagram
+linkedin: mylinkedin
 github: mygithub
-# gitlab: mygitlab
-# lastfm: mylastfm
-# stackoverflow: 7044681/mystackoverflow
-# quora: userquora
-# reddit: username
-medium: medium
-# vimeo: myvimeo
-# lanyrd: mylanyrd
 email: myemail@gmail.com
 
 authors:
-    johndoe:
-        name: John Doe
-        bio: A Man who travels the world eating noodles
-        external-image: false
-        picture: assets/images/profile.jpg
-        twitter: johndoe
-    jamesfoster:
-        name: James Foster
-        bio: A Man who develops software with coffee
-        external-image: false
-        picture: assets/images/james.jpg
-        twitter: jamesfoster
+  johndoe:
+    name: John Doe
+    bio: A Man who travels the world eating noodles
+    external-image: false
+    picture: assets/images/profile.jpg
+    twitter: johndoe
+  jamesfoster:
+    name: James Foster
+    bio: A Man who develops software with coffee
+    external-image: false
+    picture: assets/images/james.jpg
+    twitter: jamesfoster
 
 # do you want a larger site? change the option below
 # options: [normal, large] | default: normal
 # normal = 560px / large = 810px
 width: normal
 
-# if you don't need pagination, comment the *paginate* configs below
-# paginate: 5
-# paginate_path: "blog/:num/"
-
 # if you don't need projects, comment the *projects* configs below
 projects: true
 
@@ -100,20 +85,33 @@ show-author: true
 # do you want some animations?
 animation: true
 
+# add default values to specific pages or layouts
+defaults:
+  - scope:
+      path: "" # an empty string here means all files in the project
+      layout: "post"
+    values:
+      # setting all post to not hidden by default,
+      # can be overridden in the front matter for a specific post
+      hidden: false
+
 plugins:
   - jekyll-seo-tag
   - jekyll-gist
   - jekyll-feed
   - jemoji
-  - jekyll-admin
-
-jekyll-mentions:
-    base_url: https://github.com
 
 compress_html:
-    ignore:
-        envs:
-        - development
-        - stage
-
-exclude: ["travis.sh", "Rakefile", "README.md", "Gemfile", "Gemfile.lock", "FAQ.md"]
+  ignore:
+    envs:
+      - development
+      - stage
+
+exclude:
+  [
+    "README.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "FAQ.md",
+    "vendor",
+  ]
diff --git a/_includes/analytics-piwik.html b/_includes/analytics-piwik.html