Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(structure): some improvements on performance of SW and updates #119

Closed
wants to merge 1 commit into from
Closed

feat(structure): some improvements on performance of SW and updates #119

wants to merge 1 commit into from

Conversation

rios0rios0
Copy link

Description

  • updated Disqus and Google Analytics snippets
  • added OneSignal snippet and configuration
  • corrected location of Google Analytics scripts (on all head of pages)
  • corrected bug on About page (mobile version, side bar can't trigger)
  • stopped error propagation on collapsed categories
  • added an .editorconfig to standardize the code style on team
  • added some entries in .gitignore to prevent files to be included if the current dir does compile
  • removed unnecessary app.js and sw.js (new plugin of SW and better register added instead)
  • updated all versions on Gemfile and added some great plugins to future implementations

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How has this been tested

  • I have run bash ./tools/build.sh && bash ./tools/test.sh (at the root of the project) locally and passed
  • I have tested this feature in the browser

Test Configuration

  • Browerser type & version: Chrome 85.0.4183.83 (Official Build) (64-bit)
  • Operating system: Ubuntu 18.04.5 LTS
  • Bundler version: 2.1.4
  • Ruby version: 2.7.1p83
  • Jekyll version: 4.1.1

Checklist

  • My code follows the Google style guidelines
  • I have performed a self-review of my own code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

Signed-off-by: Felipe Rios felipe.rios.silva@outlook.com

@rios0rios0
feat(structure): some improvements on performance of SW and updates
ac31be3 
- updated Disqus and Google Analytics snippets
- added OneSignal snippet and configuration
- corrected location of Google Analytics scripts (on all head of pages)
- corrected bug on About page (mobile version, side bar can't trigger)
- stopped error propagation on collapsed categories
- added an .editorconfig to standardize the code style on team
- added some entries in .gitignore to prevent files to be included if the current dir does compile
- removed unnecessary app.js and sw.js (new plugin of SW and better register added instead)
- updated all versions on Gemfile and added some great plugins to future implementations

Signed-off-by: Felipe Rios <felipe.rios.silva@outlook.com>
@cotes2020
Copy link
Owner

Wow, such a big PR, but sorry, it won't be merged, let me explain why.

The problems

  • updated Disqus and Google Analytics snippets

The change to Diqus is to discard lazy loading, which will slow down page loading.

  • added OneSignal snippet and configuration

At present, this project don't need it.

  • corrected location of Google Analytics scripts (on all head of pages)

Introducing JS code in the <head> will reduce web performance.

  • corrected bug on About page (mobile version, side bar can't trigger)

I haven't seen this bug yet, may be you can open a bug issue to describe it.

  • updated all versions on Gemfile and added some great plugins to future implementations

Only the plug-ins that need to be used should be introduced.

Conclusion

A large PR can be messy and difficult to track. It is recommended that you should be precise about the goal of PR.

I am glad that you recommended .editorconfig and jekyll-pwa-plugin for me, and I will learn more about whether they can meet my needs in the future.

Your enthusiasm should be appreciated, thanks again.

@cotes2020 cotes2020 closed this Sep 3, 2020
@rios0rios0 rios0rios0 deleted the feat/some-improvements branch September 5, 2020 20:42
cotes2020 added a commit that referenced this pull request Nov 23, 2020
@cotes2020
Add editorconfig
bf88049 
Introduced by #119
ChiamYu added a commit to ChiamYu/chiamyu.github.io that referenced this pull request Apr 3, 2021
@ChiamYu @cotes2020
@hepheir @honnix @Marnick39 @onevcat @alexandra-zaharia @SilleBille @coolhva @RyanTG @dependabot-preview @bms8197 @DuchkPy
Merge chirpy update (#2)
a85d618 
* Add more option to script tool.

* Update the docs.

- Optimize the code style of markdown list
- Increase post contents (cotes2020#104, cotes2020#100)

* Improve the layout of list.

* Beautify the layout for posts heading and preview-image.

* Upgrade web-fonts source.

* Reduce the font size of inline code.

* Extend the image style to the layout `page` (cotes2020#113)

* Fix the exclusion regex rule of swatch (cotes2020#112)

* Add more details to the bug-issue template.

* Fix the path contains spaces lead to tool script failure (cotes2020#117)

* Enhance the script to remove the space between `categories`/`tags` and colon in YAML.

* Improve the deploy tool

* Pretty shell format.

* Fix condition in page creator script.

* Improve the image style.

* Improve the init tool & fix the deploy tool.

* Fix typo

change function name "deoply" -> "deploy" @ ln45, 64

* Fix the overlap of footnote in vertical direction. (cotes2020#123)

* Normalize the CSS rgb function (cotes2020#128)

* Fix the compatibility of fswatch under Linux. (cotes2020#112)

* Use yq to process YAML content (cotes2020#130)

Use yq to process YAML content.

* Improve the CD workflow and enhance the related tools.

* Update the docs for installing `yq`.

* Add `yq` installation on travis config.

* Install `yq` by APT on ubuntu of gh-actions.

`brew intall` on Ubuntu is too slow (about 1 min)

* Fix copy link function (cotes2020#133)

* Lazy load the feature image.

* Remove the tool that may confuse newbie.

* Update the docs & reduce the image size.

* Fix the bundle cache path for CD hook.

* Add styles to image caption (cotes2020#144)

* Specify the image width.

* Reduce image caption margin.

* Added caption sytle for hyperlinked images (cotes2020#144).

* Specify the image location gracefully.

* Drop the deprecating command `set-env` in actions workflow.

replace with environment files

* Add `docker` option to the tools.

* Add docker support instructions to the docs.

* Fix files r/w permissions under Linux Docker (cotes2020#145)

also improve the scripts

* Fix compatibility with Docker Desktop (for Mac)

on Docker Desktop CE (Mac) 2.4.0.0
- command `mv` will cause permission preserve error
- command `chown` will get I/O error

* Add more class to specify image position.

* Upgrade GA tag (analytics.js) to the latest tag (gtag.js)

* Remove comments from HTML.

* Add `--config` option to the build-tool.

* Add more details to the tutorial of `customize favicon`

* Optimize the hover effect of related-post card.

* Improve email javascript in sidebar (cotes2020#155)

This will appear in Firefox and Safari.

Remediates the issue describe here: https://stackoverflow.com/questions/21461589/javascript-mailto-using-window-open#32675594

* Simplify travis config.

* Fix typo (cotes2020#159)

* Fix the numeric sort of trending tags size.

* Add version tag on <head>.

* Add new tool to bump version.

* Fix the security of cross-origin destinations link.

* Replace heading elements of  panel with span.

Fix the heading levels audit.

* Improve web accessibility

- Add associated label to form elements.
- Add discernible name to links.

* Avoid GA snippet blocking HTML parsing.

* Improve the SCSS code style

* Upgrade jQuery & Bootstrap (js) to latest version.

Notes: Bootstrap CSS remains at 4.0.0

* Avoid PWA caching browser extensions.

such as: Chrome extension

* Update git-ignore list.

* Auto close the irregular issues

also fix the token key of issue-cleaner

* Using `jekyll-archives` to create category/tag pages.

* Add hook to generate the lastmod of posts

* Clean up the discarded shell scripts

* Update the docs for discarded tools

* Fix the test tool and CD hook

* Restore gem `tzinfo-data` for Windows & JRuby (cotes2020#176)

* Use `collections` to improve the tabs

* Limit Jekyll gem version

also to trigger new CI to bypass the bundle cache error in GH-Actions

* Fix bundle-install failed on gh-actions.

`--local` option of bundle-install:
  if an appropriate platform-specific gem exists on rubygems.org it will not be found.

see: <https://bundler.io/v2.1/man/bundle-install.1.html>

* Fix the relative links on sidebar tabs.

* Lock `html-proofer` in stable version (cotes2020#178)

* Update gitignore items

* Add editorconfig

Introduced by cotes2020#119

* Update issue template

* Move home breadcrumb to config.

* Generate sitemap by plugin

* Improve the bump version tool

* Improve docs

* Bump version to 2.6.0

* Fix tag <updated> and <summary> of feed.xml

* Bump version to 2.6.1

* Restore the runner tool

* Improve the issue/pr interceptor

* Fix the 404 title on mobile devices

* Bump version to 2.6.2

* Fix & rename CN version README

* Improve the interceptor action

Avoid secondary runs

* Fix yaml syntax of workflow

* Improve JS/CSS selector

Separate layout from tabs, and more friendly to tabs rename (cotes2020#187)

* Restore the archive-title that was deleted by mistake

* Change mode-toggle icon

* Regular improvement for liquid code

* Avoid mode switch button shifting

* Update runner tool

allow LAN access Jekyll

* Fix gh-actions cache not being hit issue (cotes2020#191)

* Simplify theme-mode config

* Improve travis config.

* Update the minimum version requirements of Jekyll

Jekyll allow custom sorting of collection documents from 4.x

* Simplify site config

* Add gitattributes

* Integrate with mermaid-js

* Introduce the mermaid in docs

* Update README & improve manual

* Improve the dark-mode color of the italics in code snippet

* Improve JS loading sequence

* Delay GA loading

* Fix detection of mermaid objects

* Fix underscores in the links of tags/categories (cotes2020#199)

* Update pwa cache list

* Add checkbox style to remove bogus rendered bullet (cotes2020#203)

* Improve image style (cotes2020#204)

* Improve the checkbox style (cotes2020#207)

Hotfix: the solution of cotes2020#203 will affect the layout `archives`

* Reduce the frequency of error reporting

The project maintainer determines whether it is a bug

* Add checkbox demo

* Create a more beautiful checkbox

The browser's default checkbox is too ugly, especially in dark mode

* Make table horizontal scroll (cotes2020#206)

* Revert "Improve image style (cotes2020#204)"

This reverts commit c1ef1f8.

* Improve image style (cotes2020#204)

* Always load browser default checkbox

* Beautify shape and color of checkbox

* Simplify checkbox with fontawesome icon

* Hire a new bot to deal with the issues

* Feature: Add reading time to posts

* Beautify the pin label on home page

* Optimize code snippet background color

* Feature: display the language of code snippets

* Improve code style

* Simplify the image custom class statement

* Improve CSS selector for image

* Bump version to 2.7.0

* Stop local HTML compression

* Fix the Jekyll minimum version requirement

Starting from Jekyll v4.1.0, the filter `number_of_words` accepts optional parameters to handle CKJ characters

* Simplify sidebar style

Avoid element shifting when rendering

* Optimize typography

- Set the table width to 100% on small screens
- Optimize list style
- Optimize image style
- Make checkbox color lighter (light mode)
- Reduce the space for inline code

* Jump to the anchor position smoothly

* Fix the position of the table scroll bar

* Update docs

-  Add description list sample
-  Improve doc content

* Bump version to 2.7.1

* Fix the compatibility of the smooth scrolling in Safari

Safari(at least on v14) does not support CSS property `scroll-behavior`

* Use liquid to determine whether to render ToC

* Improve GitHub stuff

- Add more events to the issue interceptor
- Reduce issue label

* Remove inline code extra content

* Fix the dir name for hosting posts

* Optimize the DOM of post link on homepage

* Update pages-deploy.yml.hook (cotes2020#229)

This change will make the baseurl configuration/testing work. Previous version failed. Posts should have /index.html as suffix in my experience.

* Improve the smooth scrolling

- Add smooth scrolling to the footnotes
- Add hash to URL

* Upgrade dependencies in Gemfile.lock

* Bump version to 2.7.2

* Add instructions to setup Page Views

This patch adds a new blog post to setup Page Views
using Google analytics superProxy.

Signed-off-by: Dinesh Prasanth M K <mkdineshprasanth@gmail.com>

* Fix nokogiri vulnerability

Upgrade nokogiri to 1.11.0.rc4  or later

* Add image CDN support & improve image lazy loading

* Remove the image files

* Add image CDN tutorial

* Prevent the URLs of code block from being clickable

* Fix typo in dark typography SCSS (cotes2020#249)

* Fix avatar url  when `site.baseurl` exists (cotes2020#253)

* Allow the PRs from dependabot

* Bump html-proofer from 3.18.3 to 3.18.5 (cotes2020#257)

Bumps [html-proofer](https://github.com/gjtorikian/html-proofer) from 3.18.3 to 3.18.5.
- [Release notes](https://github.com/gjtorikian/html-proofer/releases)
- [Commits](gjtorikian/html-proofer@v3.18.3...v3.18.5)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

* Fix baseUrl on rss-feed (cotes2020#259)

* Fix PV display when baseurl exists

* Optimize url filters

* Optimize image width of list on mobile screens

* Make code block 100% screen width on mobile

* Contact theme styles

* Fix a typo on css

* Process JS files with gulp

* Add gem-based settings

* Set default values for site variables

good for gem-based first run

* Improve the copyrights of the assets

* Optimize the embedded list style

* Update the usage instructions

* Bump version to 3.0.0

* Meaningless commit

RubyGems doesn't allow re-pushing the yanked version (3.0.0), so we have to bump a new patch version

* Bump version to 3.0.1

* Improve the gh-actions CD script

* Fix footer links

* Fix typo of docs

* Fix bump tool

* Bump version to 3.0.2

* Improve code style

- js/css
- markdown
- shell

* Fix the year of copyright

* Add new tool to build gem

* Fix toc of readme

* Bypass the jekyll build on source branch

* Merge gem-build & bump tool

Drop the yard doc

* Add more spec meta to gem

* Bump version to 3.0.3

* Add alt attribute to the post's preview image (cotes2020#271)

* Improve the docs

- Add missing url references in the tutorial
- Add gem version badge in README

* Fix post feature image style

* Exclude gem-spec from output

* Generate the breadcrumb by Liquid

also subtracted '/tabs/' from the tabs path

* Add lang option to the site config sample

* Fix gemfile

* Bump tzinfo-data from 1.2020.6 to 1.2021.1 (cotes2020#272)

Bumps [tzinfo-data](https://github.com/tzinfo/tzinfo-data) from 1.2020.6 to 1.2021.1.
- [Release notes](https://github.com/tzinfo/tzinfo-data/releases)
- [Commits](tzinfo/tzinfo-data@v1.2020.6...v1.2021.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

* Improve docs

* Reduce the font size of the Disqus prompt

* Restore the prompt in the page nav button in the latest/oldest articles

* Improved bump tool to fit the release branches

* Update travis settings for release-branches

- drop the deprecated flag `--deployment` of bundle (so we have to specify the bundler caching path)

* Bump version to 3.1.0

* Update dependencies in Gemfile.lock

* Give travis a new job: monitor the starter files

* Use regex in site exclusion list

* Hide empty categries/tags in search (cotes2020#273)

* Fix search results slow scrolling (cotes2020#273)

also:
- improve its responsive design
- fix the js path in gulp

* Add a modification to `Gemfile.lock` in bump tool

* Bump version to 3.1.1

* Improve the width of search results items (fix cotes2020#276)

* Fix typo in readme & quick-start tutorial

* Optimize the language badge position in code block

* Add branches notice to the Docs

* Improve the bump tool

* Bump version to 3.2.0

(cherry picked from commit bb6d5ea)

* Restore the copy link button in the post sharing option

Affected version >= 3.0.3, <= 3.2.0

* Bump version to 3.2.1

(cherry picked from commit 759579c)

* Fix image width in the list (when screen width is 768px)

* Migration from BMC to Ko-fi

* Update the condition of issues intercept

* Update the prompt of comments

* Restore the year of first publication in footer

* Update the sponsor buttons

* Improve the bump tool

* Bump html-proofer from 3.18.5 to 3.18.6

Bumps [html-proofer](https://github.com/gjtorikian/html-proofer) from 3.18.5 to 3.18.6.
- [Release notes](https://github.com/gjtorikian/html-proofer/releases)
- [Commits](gjtorikian/html-proofer@v3.18.5...v3.18.6)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Change the order of post meta & improve timeago

* Change the bundle cache path on gh-actions

ubuntu-latest changed from 18.04 TLS to 20.04 LTS causes a file path change to the `ffi` gem, invalidating the gh-actions cache file, and causes the build to fail.

See: <ffi/ffi#769>

* Fix the corners of the page navigation buttons of the latest/oldest post

* Bump version to 3.2.2

(cherry picked from commit 6b63336)

* Improve the pattern of issue bot

* Support TeX and LaTeX math delimiters (cotes2020#243)

* Update typing error

* Disable configuration option 'site.author'

* Revert "Restore the year of first publication in footer"

This reverts commit 28eb18a.

* Fix PWA error caused by service worker store the POST Request as cache key

fix cotes2020#297, fix cotes2020#301

* Fix the cache list on service worker

Adding '/index.html' to the cache storage

* Fix a code snippet of tutorial

* Update docs

- Remove ToC
- Remove JetBrains logo from readme
- Update funding options

* [Security] Bump kramdown from 2.3.0 to 2.3.1

Bumps [kramdown](https://github.com/gettalong/kramdown) from 2.3.0 to 2.3.1. **This update includes a security fix.**
- [Release notes](https://github.com/gettalong/kramdown/releases)
- [Changelog](https://github.com/gettalong/kramdown/blob/master/doc/news.page)
- [Commits](https://github.com/gettalong/kramdown/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Update ruby setup actions (fix cotes2020#306)

No longer tracking Gemfile.lock

* Remove a stale variable from timeago.js

* Rename copyright file for JS

* Optimize the typo color

* Update the bump tool

* Bump version to 3.3.0

(cherry picked from commit d31b36c)

* Fix the MathJax config was lost in jekyll-compress-html

* Bump version to 3.3.1

(cherry picked from commit 8dbef1b)

* Remove default post

* Fix reverted post

Co-authored-by: Cotes Chung <11371340+cotes2020@users.noreply.github.com>
Co-authored-by: 김동주 <hepheir@gmail.com>
Co-authored-by: Honnix <honnix@users.noreply.github.com>
Co-authored-by: Marnick Vandecauter <Marnick.Vandecauter@hotmail.com>
Co-authored-by: Wei Wang <onevcat@gmail.com>
Co-authored-by: Alexandra Zaharia <7894916+alexandra-zaharia@users.noreply.github.com>
Co-authored-by: Dinesh Prasanth M K <SilleBille@users.noreply.github.com>
Co-authored-by: Henk van Achterberg <coolhva@gmail.com>
Co-authored-by: Dinesh Prasanth M K <mkdineshprasanth@gmail.com>
Co-authored-by: Ryan TG <RyanTG@users.noreply.github.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Bogdan Stoica <bms8197@users.noreply.github.com>
Co-authored-by: DuchkPy <36851093+DuchkPy@users.noreply.github.com>
sanjidnet pushed a commit to sanjidnet/sanjidnet.github.io that referenced this pull request Aug 24, 2021
@cotes2020
Add editorconfig
5e722f2 
Introduced by cotes2020#119
cotes2020 added a commit that referenced this pull request Oct 22, 2021
@cotes2020
Add editorconfig
43d4036 
Introduced by #119
sanjidnet pushed a commit to sanjidnet/sanjidnet.github.io that referenced this pull request Dec 26, 2023
@cotes2020 @sanjidnet
Add editorconfig
d9e6dc7 
Introduced by cotes2020#119
JOEIH pushed a commit to JOEIH/JOEIH.github.io that referenced this pull request Apr 28, 2024
@jeffreytse
feat: custom selection style support (cotes2020#119)
f3d2a6f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rios0rios0 @cotes2020