diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index 160750d6b08..d0cc84a36dd 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -35,3 +35,6 @@ jobs: publish: needs: release uses: ./.github/workflows/publish.yml + secrets: + GH_PAT: ${{ secrets.GH_PAT }} + BUILDER: ${{ secrets.BUILDER }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 078e4f13e11..fa8d0c9ee05 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,6 +3,7 @@ on: push: branches: - "master" + - "hotfix/**" paths-ignore: - ".github/**" - "!.github/workflows/ci.yml" diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 20e46915167..99114ea3cb6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -5,6 +5,11 @@ on: branches: - docs workflow_call: + secrets: + GH_PAT: + required: true + BUILDER: + required: true jobs: launch: diff --git a/.github/workflows/style-lint.yml b/.github/workflows/style-lint.yml index 89eeaeffe0f..a2cf4f69b7a 100644 --- a/.github/workflows/style-lint.yml +++ b/.github/workflows/style-lint.yml @@ -2,7 +2,7 @@ name: "Style Lint" on: push: - branches: ["master"] + branches: ["master", "hotfix/**"] paths: ["_sass/**/*.scss"] pull_request: paths: ["_sass/**/*.scss"] diff --git a/_data/origin/cors.yml b/_data/origin/cors.yml index abedb6c6ed4..18806665698 100644 --- a/_data/origin/cors.yml +++ b/_data/origin/cors.yml @@ -20,24 +20,24 @@ webfonts: https://fonts.googleapis.com/css2?family=Lato:wght@300;400&family=Sour # Libraries toc: - css: https://cdn.jsdelivr.net/npm/tocbot@4.25.0/dist/tocbot.min.css - js: https://cdn.jsdelivr.net/npm/tocbot@4.25.0/dist/tocbot.min.js + css: https://cdn.jsdelivr.net/npm/tocbot@4.27.20/dist/tocbot.min.css + js: https://cdn.jsdelivr.net/npm/tocbot@4.27.20/dist/tocbot.min.js fontawesome: - css: https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.5.1/css/all.min.css + css: https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.5.2/css/all.min.css search: js: https://cdn.jsdelivr.net/npm/simple-jekyll-search@1.10.0/dest/simple-jekyll-search.min.js mermaid: - js: https://cdn.jsdelivr.net/npm/mermaid@10.8.0/dist/mermaid.min.js + js: https://cdn.jsdelivr.net/npm/mermaid@10.9.0/dist/mermaid.min.js dayjs: js: - common: https://cdn.jsdelivr.net/npm/dayjs@1.11.10/dayjs.min.js - locale: https://cdn.jsdelivr.net/npm/dayjs@1.11.10/locale/:LOCALE.min.js - relativeTime: https://cdn.jsdelivr.net/npm/dayjs@1.11.10/plugin/relativeTime.min.js - localizedFormat: https://cdn.jsdelivr.net/npm/dayjs@1.11.10/plugin/localizedFormat.min.js + common: https://cdn.jsdelivr.net/npm/dayjs@1.11.11/dayjs.min.js + locale: https://cdn.jsdelivr.net/npm/dayjs@1.11.11/locale/:LOCALE.min.js + relativeTime: https://cdn.jsdelivr.net/npm/dayjs@1.11.11/plugin/relativeTime.min.js + localizedFormat: https://cdn.jsdelivr.net/npm/dayjs@1.11.11/plugin/localizedFormat.min.js glightbox: css: https://cdn.jsdelivr.net/npm/glightbox@3.3.0/dist/css/glightbox.min.css diff --git a/_includes/embed/audio.html b/_includes/embed/audio.html index e2b897901e2..cf928a7f835 100644 --- a/_includes/embed/audio.html +++ b/_includes/embed/audio.html @@ -4,7 +4,7 @@ {% unless src contains '://' %} {%- capture src -%} - {% include media-url.html src=src %} + {% include media-url.html src=src subpath=page.media_subpath %} {%- endcapture -%} {% endunless %} diff --git a/_includes/embed/video.html b/_includes/embed/video.html index 712a266a345..9b6918f7b57 100644 --- a/_includes/embed/video.html +++ b/_includes/embed/video.html @@ -5,7 +5,7 @@ {% unless video_url contains '://' %} {%- capture video_url -%} - {% include media-url.html src=video_url %} + {% include media-url.html src=video_url subpath=page.media_subpath %} {%- endcapture -%} {% endunless %} diff --git a/_includes/pageviews/goatcounter.html b/_includes/pageviews/goatcounter.html index af536dbdd7c..e62fd698d9b 100644 --- a/_includes/pageviews/goatcounter.html +++ b/_includes/pageviews/goatcounter.html @@ -9,7 +9,8 @@ fetch(url) .then((response) => response.json()) .then((data) => { - pv.innerText = new Intl.NumberFormat().format(data.count); + const count = data.count.replace(/\s/g, ''); + pv.innerText = new Intl.NumberFormat().format(count); }) .catch((error) => { pv.innerText = '1'; diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index bda7705e464..e6259ba3bf9 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -107,76 +107,35 @@ comments: false --- ``` -## Mathematics - -We use [**MathJax**][mathjax] to generate mathematics. For website performance reasons, the mathematical feature won't be loaded by default. But it can be enabled by: - -[mathjax]: https://www.mathjax.org/ +## Media -```yaml ---- -math: true ---- -``` +We refer to images, audio and video as media resources in _Chirpy_. -After enabling the mathematical feature, you can add math equations with the following syntax: +### URL Prefix -- **Block math** should be added with `$$ math $$` with **mandatory** blank lines before and after `$$` - - **Inserting equation numbering** should be added with `$$\begin{equation} math \end{equation}$$` - - **Referencing equation numbering** should be done with `\label{eq:label_name}` in the equation block and `\eqref{eq:label_name}` inline with text (see example below) -- **Inline math** (in lines) should be added with `$$ math $$` without any blank line before or after `$$` -- **Inline math** (in lists) should be added with `\$$ math $$` +From time to time we have to define duplicate URL prefixes for multiple resources in a post, which is a boring task that you can avoid by setting two parameters. -```markdown - - -$$ -LaTeX_math_expression -$$ - - - -$$ -\begin{equation} - LaTeX_math_expression - \label{eq:label_name} -\end{equation} -$$ +- If you are using a CDN to host media files, you can specify the `cdn` in `_config.yml`{: .filepath }. The URLs of media resources for site avatar and posts are then prefixed with the CDN domain name. -Can be referenced as \eqref{eq:label_name}. - - - -"Lorem ipsum dolor sit amet, $$ LaTeX_math_expression $$ consectetur adipiscing elit." - - - -1. \$$ LaTeX_math_expression $$ -2. \$$ LaTeX_math_expression $$ -3. \$$ LaTeX_math_expression $$ -``` - -> Starting with `v7.0.0`, configuration options for **MathJax** have been moved to file `assets/js/data/mathjax.js`{: .filepath }, and you can change the options as needed, such as adding [extensions][mathjax-exts]. -> If you are building the site via `chirpy-starter`, copy that file from the gem installation directory (check with command `bundle info --path jekyll-theme-chirpy`) to the same directory in your repository. -{: .prompt-tip } - -[mathjax-exts]: https://docs.mathjax.org/en/latest/input/tex/extensions/index.html - -## Mermaid + ```yaml + cdn: https://cdn.com + ``` + {: file='_config.yml' .nolineno } -[**Mermaid**](https://github.com/mermaid-js/mermaid) is a great diagram generation tool. To enable it on your post, add the following to the YAML block: +- To specify the resource path prefix for the current post/page range, set `media_subpath` in the _front matter_ of the post: -```yaml ---- -mermaid: true ---- -``` + ```yaml + --- + media_subpath: /path/to/media/ + --- + ``` + {: .nolineno } -Then you can use it like other markdown languages: surround the graph code with ```` ```mermaid ```` and ```` ``` ````. +The option `site.cdn` and `page.media_subpath` can be used individually or in combination to flexibly compose the final resource URL: `[site.cdn/][page.media_subpath/]file.ext` -## Images +### Images -### Caption +#### Caption Add italics to the next line of an image, then it will become the caption and appear at the bottom of the image: @@ -186,7 +145,7 @@ _Image Caption_ ``` {: .nolineno} -### Size +#### Size In order to prevent the page content layout from shifting when the image is loaded, we should set the width and height for each image. @@ -205,7 +164,7 @@ Starting from _Chirpy v5.0.0_, `height` and `width` support abbreviations (`heig ``` {: .nolineno} -### Position +#### Position By default, the image is centered, but you can specify the position by using one of the classes `normal`, `left`, and `right`. @@ -235,7 +194,7 @@ By default, the image is centered, but you can specify the position by using one ``` {: .nolineno} -### Dark/Light mode +#### Dark/Light mode You can make images follow theme preferences in dark/light mode. This requires you to prepare two images, one for dark mode and one for light mode, and then assign them a specific class (`dark` or `light`): @@ -244,7 +203,7 @@ You can make images follow theme preferences in dark/light mode. This requires y ![Dark mode only](/path/to/dark-mode.png){: .dark } ``` -### Shadow +#### Shadow The screenshots of the program window can be considered to show the shadow effect: @@ -253,56 +212,7 @@ The screenshots of the program window can be considered to show the shadow effec ``` {: .nolineno} -### CDN URL - -If you host the media resources on the CDN, you can save the time of repeatedly writing the CDN URL by assigning the variable `cdn` of `_config.yml`{: .filepath} file: - -```yaml -cdn: https://cdn.com -``` -{: file='_config.yml' .nolineno} - -Once `cdn` is assigned, the CDN URL will be added to the path of all media resources (site avatar, posts' images, audio and video files) starting with `/`. - -For instance, when using images: - -```markdown -![The flower](/path/to/flower.png) -``` -{: .nolineno} - -The parsing result will automatically add the CDN prefix `https://cdn.com` before the image path: - -```html -The flower -``` -{: .nolineno } - -### Media Subpath - -When a post contains many images, it will be a time-consuming task to repeatedly define the path of the media resources. To solve this, we can define this path in the YAML block of the post: - -```yml ---- -media_subpath: /img/path/ ---- -``` - -And then, the image source of Markdown can write the file name directly: - -```md -![The flower](flower.png) -``` -{: .nolineno } - -The output will be: - -```html -The flower -``` -{: .nolineno } - -### Preview Image +#### Preview Image If you want to add an image at the top of the post, please provide an image with a resolution of `1200 x 630`. Please note that if the image aspect ratio does not meet `1.91 : 1`, the image will be scaled and cropped. @@ -316,7 +226,7 @@ image: --- ``` -Note that the [`media_subpath`](#media-subpath) can also be passed to the preview image, that is, when it has been set, the attribute `path` only needs the image file name. +Note that the [`media_subpath`](#url-prefix) can also be passed to the preview image, that is, when it has been set, the attribute `path` only needs the image file name. For simple use, you can also just use `image` to define the path. @@ -326,7 +236,7 @@ image: /path/to/image --- ``` -### LQIP +#### LQIP For preview images: @@ -346,6 +256,86 @@ For normal images: ``` {: .nolineno } +### Video + +#### Social Media Platform + +You can embed videos from social media platforms with the following syntax: + +```liquid +{% include embed/{Platform}.html id='{ID}' %} +``` + +Where `Platform` is the lowercase of the platform name, and `ID` is the video ID. + +The following table shows how to get the two parameters we need in a given video URL, and you can also know the currently supported video platforms. + +| Video URL | Platform | ID | +| -------------------------------------------------------------------------------------------------- | ---------- | :------------- | +| [https://www.**youtube**.com/watch?v=**H-B46URT4mg**](https://www.youtube.com/watch?v=H-B46URT4mg) | `youtube` | `H-B46URT4mg` | +| [https://www.**twitch**.tv/videos/**1634779211**](https://www.twitch.tv/videos/1634779211) | `twitch` | `1634779211` | +| [https://www.**bilibili**.com/video/**BV1Q44y1B7Wf**](https://www.bilibili.com/video/BV1Q44y1B7Wf) | `bilibili` | `BV1Q44y1B7Wf` | + +#### Video Files + +If you want to embed a video file directly, use the following syntax: + +```liquid +{% include embed/video.html src='{URL}' %} +``` + +Where `URL` is an URL to a video file e.g. `/path/to/sample/video.mp4`. + +You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed. + +- `poster='/path/to/poster.png'` — poster image for a video that is shown while video is downloading +- `title='Text'` — title for a video that appears below the video and looks same as for images +- `autoplay=true` — video automatically begins to play back as soon as it can +- `loop=true` — automatically seek back to the start upon reaching the end of the video +- `muted=true` — audio will be initially silenced +- `types` — specify the extensions of additional video formats separated by `|`. Ensure these files exist in the same directory as your primary video file. + +Consider an example utilizing all of the above: + +```liquid +{% + include embed/video.html + src='/path/to/video.mp4' + types='ogg|mov' + poster='poster.png' + title='Demo video' + autoplay=true + loop=true + muted=true +%} +``` + +### Audios + +If you want to embed an audio file directly, use the following syntax: + +```liquid +{% include embed/audio.html src='{URL}' %} +``` + +Where `URL` is an URL to an audio file e.g. `/path/to/audio.mp3`. + +You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed. + +- `title='Text'` — title for an audio that appears below the audio and looks same as for images +- `types` — specify the extensions of additional audio formats separated by `|`. Ensure these files exist in the same directory as your primary audio file. + +Consider an example utilizing all of the above: + +```liquid +{% + include embed/audio.html + src='/path/to/audio.mp3' + types='ogg|wav|aac' + title='Demo audio' +%} +``` + ## Pinned Posts You can pin one or more posts to the top of the home page, and the fixed posts are sorted in reverse order according to their release date. Enable by: @@ -443,95 +433,74 @@ If you want to display the **Liquid** snippet, surround the liquid code with `{% Or adding `render_with_liquid: false` (Requires Jekyll 4.0 or higher) to the post's YAML block. -## Videos - -### Video Sharing Platform - -You can embed a video with the following syntax: - -```liquid -{% include embed/{Platform}.html id='{ID}' %} ``` -Where `Platform` is the lowercase of the platform name, and `ID` is the video ID. - -The following table shows how to get the two parameters we need in a given video URL, and you can also know the currently supported video platforms. - -| Video URL | Platform | ID | -| -------------------------------------------------------------------------------------------------- | ---------- | :------------- | -| [https://www.**youtube**.com/watch?v=**H-B46URT4mg**](https://www.youtube.com/watch?v=H-B46URT4mg) | `youtube` | `H-B46URT4mg` | -| [https://www.**twitch**.tv/videos/**1634779211**](https://www.twitch.tv/videos/1634779211) | `twitch` | `1634779211` | -| [https://www.**bilibili**.com/video/**BV1Q44y1B7Wf**](https://www.bilibili.com/video/BV1Q44y1B7Wf) | `bilibili` | `BV1Q44y1B7Wf` | +## Mathematics -### Video File +We use [**MathJax**][mathjax] to generate mathematics. For website performance reasons, the mathematical feature won't be loaded by default. But it can be enabled by: -If you want to embed a video file directly, use the following syntax: +[mathjax]: https://www.mathjax.org/ -```liquid -{% include embed/video.html src='{URL}' %} +```yaml +--- +math: true +--- ``` -Where `URL` is an URL to a video file e.g. `/assets/img/sample/video.mp4`. +After enabling the mathematical feature, you can add math equations with the following syntax: -You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed. +- **Block math** should be added with `$$ math $$` with **mandatory** blank lines before and after `$$` + - **Inserting equation numbering** should be added with `$$\begin{equation} math \end{equation}$$` + - **Referencing equation numbering** should be done with `\label{eq:label_name}` in the equation block and `\eqref{eq:label_name}` inline with text (see example below) +- **Inline math** (in lines) should be added with `$$ math $$` without any blank line before or after `$$` +- **Inline math** (in lists) should be added with `\$$ math $$` -- `poster='/path/to/poster.png'` - poster image for a video that is shown while video is downloading -- `title='Text'` - title for a video that appears below the video and looks same as for images -- `autoplay=true` - video automatically begins to play back as soon as it can -- `loop=true` - automatically seek back to the start upon reaching the end of the video -- `muted=true` - audio will be initially silenced -- `types` - specify the extensions of additional video formats separated by `|`. Ensure these files exist in the same directory as your primary video file. +```markdown + -Consider an example utilizing all of the above: +$$ +LaTeX_math_expression +$$ -```liquid -{% - include embed/video.html - src='/path/to/video/video.mp4' - types='ogg|mov' - poster='poster.png' - title='Demo video' - autoplay=true - loop=true - muted=true -%} -``` + -> It's not recommended to host video files in `assets` folder as they cannot be cached by PWA and may cause issues. -> Instead, use CDN to host video files. Alternatively, use a separate folder that is excluded from PWA (see `pwa.deny_paths` setting in `_config.yml`). -{: .prompt-warning } +$$ +\begin{equation} + LaTeX_math_expression + \label{eq:label_name} +\end{equation} +$$ + +Can be referenced as \eqref{eq:label_name}. -## Audios + -### Audio File +"Lorem ipsum dolor sit amet, $$ LaTeX_math_expression $$ consectetur adipiscing elit." -If you want to embed an audio file directly, use the following syntax: + -```liquid -{% include embed/audio.html src='{URL}' %} +1. \$$ LaTeX_math_expression $$ +2. \$$ LaTeX_math_expression $$ +3. \$$ LaTeX_math_expression $$ ``` -Where `URL` is an URL to an audio file e.g. `/assets/img/sample/audio.mp3`. +> Starting with `v7.0.0`, configuration options for **MathJax** have been moved to file `assets/js/data/mathjax.js`{: .filepath }, and you can change the options as needed, such as adding [extensions][mathjax-exts]. +> If you are building the site via `chirpy-starter`, copy that file from the gem installation directory (check with command `bundle info --path jekyll-theme-chirpy`) to the same directory in your repository. +{: .prompt-tip } -You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed. +[mathjax-exts]: https://docs.mathjax.org/en/latest/input/tex/extensions/index.html -- `title='Text'` - title for an audio that appears below the audio and looks same as for images -- `types` - specify the extensions of additional audio formats separated by `|`. Ensure these files exist in the same directory as your primary audio file. +## Mermaid -Consider an example utilizing all of the above: +[**Mermaid**](https://github.com/mermaid-js/mermaid) is a great diagram generation tool. To enable it on your post, add the following to the YAML block: -```liquid -{% - include embed/audio.html - src='/path/to/audio/audio.mp3' - types='ogg|wav|aac' - title='Demo audio' -%} +```yaml +--- +mermaid: true +--- ``` -> It's not recommended to host audio files in `assets` folder as they cannot be cached by PWA and may cause issues. -> Instead, use CDN to host audio files. Alternatively, use a separate folder that is excluded from PWA (see `pwa.deny_paths` setting in `_config.yml`). -{: .prompt-warning } +Then you can use it like other markdown languages: surround the graph code with ```` ```mermaid ```` and ```` ``` ````. ## Learn More diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 777e27b277e..abe0a1783c9 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [7.0.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.0.0...v7.0.1) (2024-05-18) + +### Bug Fixes + +* **analytics:** goatcounter pv greater than 1K cannot be converted to numbers ([#1762](https://github.com/cotes2020/jekyll-theme-chirpy/issues/1762)) ([33a1fa7](https://github.com/cotes2020/jekyll-theme-chirpy/commit/33a1fa7cae2181625e2f335708d59de4dd20ee7d)) +* audio/video path apply variable `media_subpath` ([#1745](https://github.com/cotes2020/jekyll-theme-chirpy/issues/1745)) ([00a27a1](https://github.com/cotes2020/jekyll-theme-chirpy/commit/00a27a1b85f665d0642b77babd54c6903fbdeb22)) + ## [7.0.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.5...v7.0.0) (2024-05-11) ### ⚠ BREAKING CHANGES diff --git a/jekyll-theme-chirpy.gemspec b/jekyll-theme-chirpy.gemspec index 88d5c4240ad..91d618c156f 100644 --- a/jekyll-theme-chirpy.gemspec +++ b/jekyll-theme-chirpy.gemspec @@ -2,7 +2,7 @@ Gem::Specification.new do |spec| spec.name = "jekyll-theme-chirpy" - spec.version = "7.0.0" + spec.version = "7.0.1" spec.authors = ["Cotes Chung"] spec.email = ["cotes.chung@gmail.com"] diff --git a/package.json b/package.json index 00f8545330d..8600aa4ee5e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jekyll-theme-chirpy", - "version": "7.0.0", + "version": "7.0.1", "description": "A minimal, responsive, and feature-rich Jekyll theme for technical writing.", "repository": { "type": "git",