Merge pull request #1 from yat-robot/develop

Added first draft of project's planning

.github/FUNDING.yml

@@ -10,4 +10,3 @@ liberapay: jeffreytse
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
 custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
-

.github/workflows/build-jekyll.yml

@@ -1,33 +1,33 @@
 name: Github Pages
 
 on:
-  push:
-    branches:
-      - master  # Here source code branch is `master`, it could be other branch
+    push:
+        branches:
+            - master # Here source code branch is `master`, it could be other branch
 
 jobs:
-  build_and_deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
+    build_and_deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
 
-      # Use GitHub Actions' cache to cache dependencies on servers
-      - uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
+            # Use GitHub Actions' cache to cache dependencies on servers
+            - uses: actions/cache@v1
+              with:
+                  path: vendor/bundle
+                  key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-gems-
 
-      # Use GitHub Deploy Action to build and deploy to Github
-      - uses: jeffreytse/jekyll-deploy-action@master
-        with:
-          provider: 'github'
-          token: ${{ secrets.GITHUB_TOKEN }} # It's your Personal Access Token(PAT)
-          repository: ''             # Default is current repository
-          branch: 'gh-pages'         # Default is gh-pages for github provider
-          jekyll_src: './'           # Default is root directory
-          jekyll_cfg: '_config.yml'  # Default is _config.yml
-          jekyll_baseurl: '/jekyll-theme-yat'  # Default is empty
-          cname: ''                  # Default is to not use a cname
-          actor: ''                  # Default is the GITHUB_ACTOR
+            # Use GitHub Deploy Action to build and deploy to Github
+            - uses: jeffreytse/jekyll-deploy-action@master
+              with:
+                  provider: "github"
+                  token: ${{ secrets.GITHUB_TOKEN }} # It's your Personal Access Token(PAT)
+                  repository: "" # Default is current repository
+                  branch: "gh-pages" # Default is gh-pages for github provider
+                  jekyll_src: "./" # Default is root directory
+                  jekyll_cfg: "_config.yml" # Default is _config.yml
+                  jekyll_baseurl: "/jekyll-theme-yat" # Default is empty
+                  cname: "" # Default is to not use a cname
+                  actor: "" # Default is the GITHUB_ACTOR

.github/workflows/pre-commit.yaml

@@ -0,0 +1,15 @@
+name: pre-commit action
+
+on:
+    pull_request:
+        branches: [main, develop]
+    push:
+        branches: [main, develop]
+
+jobs:
+    pre-commit:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-python@v3
+            - uses: pre-commit/[email protected]

.gitignore

@@ -1,5 +1,11 @@
+# Jekyll
 *.gem
 .bundle
 .sass-cache
 _site
 Gemfile.lock
+
+# Node
+node_modules/
+package-lock.json
+package.json

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v2.3.0
+      hooks:
+          - id: check-yaml
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+          - id: end-of-file-fixer
+          - id: check-merge-conflict
+
+    - repo: https://github.com/pre-commit/mirrors-prettier
+      rev: v3.1.0
+      hooks:
+          - id: prettier

.prettierignore

@@ -0,0 +1 @@
+assets/css/main.scss

.prettierrc.yaml

@@ -0,0 +1,5 @@
+# .prettierrc or .prettierrc.yaml
+trailingComma: "es5"
+tabWidth: 4
+semi: false
+singleQuote: false

Gemfile

@@ -2,4 +2,3 @@
 
 source "https://rubygems.org"
 gemspec
-

README.md

@@ -80,33 +80,33 @@ I will respect your crucial support and say THANK YOU!
 
 ## Features
 
-- Support beautiful **Night Mode**.
-- Modern responsive web design.
-- Full layouts `home`, `post`, `tags`, `archive` and `about`.
-- Uses font awesome 5 for icons.
-- Beautiful page banner with image and video.
-- Beautiful Syntax Highlight using [highlight.js][highlight-js].
-- Beautiful image gallery previewer using [PhotoSwipe 5][photoswipe-5].
-- RSS support using [Jekyll Feed][jekyll-feed] gem.
-- Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem.
-- Sitemap support using [Jekyll Sitemap][jekyll-sitemap] gem.
-- Complex and flexible table support using [Jekyll Spaceship][jekyll-spaceship] gem.
-- MathJAX and LaTeX optional support using [Jekyll Spaceship][jekyll-spaceship] gem.
-- Media (Youtube, Spotify, etc.) support using [Jekyll Spaceship][jekyll-spaceship] gem.
-- Diagram (PlantUML, Mermaid) support using [Jekyll Spaceship][jekyll-spaceship] gem.
-- Google Translation support.
-- New post tag support.
-- Pin post tag support.
+-   Support beautiful **Night Mode**.
+-   Modern responsive web design.
+-   Full layouts `home`, `post`, `tags`, `archive` and `about`.
+-   Uses font awesome 5 for icons.
+-   Beautiful page banner with image and video.
+-   Beautiful Syntax Highlight using [highlight.js][highlight-js].
+-   Beautiful image gallery previewer using [PhotoSwipe 5][photoswipe-5].
+-   RSS support using [Jekyll Feed][jekyll-feed] gem.
+-   Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem.
+-   Sitemap support using [Jekyll Sitemap][jekyll-sitemap] gem.
+-   Complex and flexible table support using [Jekyll Spaceship][jekyll-spaceship] gem.
+-   MathJAX and LaTeX optional support using [Jekyll Spaceship][jekyll-spaceship] gem.
+-   Media (Youtube, Spotify, etc.) support using [Jekyll Spaceship][jekyll-spaceship] gem.
+-   Diagram (PlantUML, Mermaid) support using [Jekyll Spaceship][jekyll-spaceship] gem.
+-   Google Translation support.
+-   New post tag support.
+-   Pin post tag support.
 
 Also, visit the [Live Demo][yat-live-demo] site for the theme.
 
 ## Installation
 
 There are three ways to install:
 
-- As a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes).
-- As a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible).
-- Forking/directly copying all of the theme files into your project.
+-   As a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes).
+-   As a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible).
+-   Forking/directly copying all of the theme files into your project.
 
 ### Gem-based Theme Method
 

_config.yml

@@ -43,9 +43,9 @@ author: Gonzalo G. Fernandez
 copyright: "Unpublished Work (cleft) 2023-{currentYear} {author}"
 
 description: >- # this means to ignore newlines until "baseurl:"
-  Write an awesome description for your new site here. You can edit this
-  line in _config.yml. It will appear in your document head meta (for
-  Google search results) and in your feed.xml site description.
+    Write an awesome description for your new site here. You can edit this
+    line in _config.yml. It will appear in your document head meta (for
+    Google search results) and in your feed.xml site description.
 
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. https://example.com
@@ -54,7 +54,7 @@ favicon: "/assets/images/yat-favicon-color.png" # the favicon for your site
 # Yat date format
 # refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this
 yat:
-  date_format: "%b %d, %Y"
+    date_format: "%b %d, %Y"
 
 # If you want more debug log, you can set true
 # debug: false
@@ -241,11 +241,11 @@ yat:
 # highlighter: none
 markdown: kramdown
 kramdown:
-  input: GFM
+    input: GFM
 
 plugins:
-  - jekyll-feed
-  - jekyll-seo-tag
-  - jekyll-sitemap
-  - jekyll-paginate
-  - jekyll-spaceship
+    - jekyll-feed
+    - jekyll-seo-tag
+    - jekyll-sitemap
+    - jekyll-paginate
+    - jekyll-spaceship

_data/defaults.yml

@@ -1,4 +1,4 @@
 home:
-  heading: "Yet Another TurtleBot"
-  subheading: "Two-wheeled mobile robot based on SoC Zynq 7000"
-  banner: "Your image url"
+    heading: "Yet Another TurtleBot"
+    subheading: "Two-wheeled mobile robot based on SoC Zynq 7000"
+    banner: "Your image url"

_includes/custom-head.html

@@ -1,6 +1,5 @@
-{% comment %}
-  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons:
-
-  1. Head over to https://realfavicongenerator.net/ to add your own favicons.
-  2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet.
-{% endcomment %}
+{% comment %} Placeholder to allow defining custom head, in principle, you can
+add anything here, e.g. favicons: 1. Head over to
+https://realfavicongenerator.net/ to add your own favicons. 2. Customize default
+_includes/custom-head.html in your source directory and insert the given code
+snippet. {% endcomment %}

_includes/extensions/click-to-top.html

@@ -1,18 +1,18 @@
 <div id="click-to-top" class="click-to-top">
-  <i class="fa fa-arrow-up"></i>
+    <i class="fa fa-arrow-up"></i>
 </div>
 <script>
-  (function () {
-    const clickToTop = document.getElementById('click-to-top');
-    window.addEventListener('scroll', () => {
-      if (window.scrollY > 100) {
-        clickToTop.classList.add('show')
-      }else {
-        clickToTop.classList.remove('show')
-      }
-    });
-    clickToTop.addEventListener('click', () => {
-      window.smoothScrollTo(0);
-    });
-  })();
+    ;(function () {
+        const clickToTop = document.getElementById("click-to-top")
+        window.addEventListener("scroll", () => {
+            if (window.scrollY > 100) {
+                clickToTop.classList.add("show")
+            } else {
+                clickToTop.classList.remove("show")
+            }
+        })
+        clickToTop.addEventListener("click", () => {
+            window.smoothScrollTo(0)
+        })
+    })()
 </script>