8d23eb0c91
* build(deps): bump the npm group across 1 directory with 4 updates Updates the requirements on [@fortawesome/fontawesome-free](https://github.com/FortAwesome/Font-Awesome), [dayjs](https://github.com/iamkun/dayjs), [mermaid](https://github.com/mermaid-js/mermaid) and [tocbot](https://github.com/tscanlin/tocbot) to permit the latest version. Updates `@fortawesome/fontawesome-free` to 6.6.0 - [Release notes](https://github.com/FortAwesome/Font-Awesome/releases) - [Changelog](https://github.com/FortAwesome/Font-Awesome/blob/6.x/CHANGELOG.md) - [Commits](https://github.com/FortAwesome/Font-Awesome/compare/6.5.2...6.6.0) Updates `dayjs` to 1.11.13 - [Release notes](https://github.com/iamkun/dayjs/releases) - [Changelog](https://github.com/iamkun/dayjs/blob/v1.11.13/CHANGELOG.md) - [Commits](https://github.com/iamkun/dayjs/compare/v1.11.11...v1.11.13) Updates `mermaid` from 10.9.1 to 11.0.2 - [Release notes](https://github.com/mermaid-js/mermaid/releases) - [Changelog](https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md) - [Commits](https://github.com/mermaid-js/mermaid/compare/v10.9.1...mermaid@11.0.2) Updates `tocbot` to 4.29.0 - [Release notes](https://github.com/tscanlin/tocbot/releases) - [Changelog](https://github.com/tscanlin/tocbot/blob/master/CHANGELOG.md) - [Commits](https://github.com/tscanlin/tocbot/compare/v4.27.20...v4.29.0) --- updated-dependencies: - dependency-name: "@fortawesome/fontawesome-free" dependency-type: direct:production dependency-group: npm - dependency-name: dayjs dependency-type: direct:production dependency-group: npm - dependency-name: mermaid dependency-type: direct:production update-type: version-update:semver-major dependency-group: npm - dependency-name: tocbot dependency-type: direct:production dependency-group: npm ... Signed-off-by: dependabot[bot] <support@github.com> * docs: update deps versions in readme * chore: update assets --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Cotes Chung <11371340+cotes2020@users.noreply.github.com>
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# Static Assets for Chirpy Jekyll Theme
|
|
|
|
## Introduction
|
|
|
|
Static assets (libraries/plugins/web-fonts) required by the [_Chirpy_][chirpy] based website to run. It provides the opportunity to choose self-host assets in production or development mode.
|
|
|
|
## Usage
|
|
|
|
- If you want to use these assets only in local development:
|
|
|
|
Go to the root of your site and clone the assets as follows:
|
|
|
|
```console
|
|
$ git submodule init
|
|
$ git submodule update
|
|
```
|
|
|
|
And then set your site configuration options:
|
|
|
|
```yml
|
|
# _config.yml
|
|
assets:
|
|
self_host:
|
|
enabled: true
|
|
env: development
|
|
```
|
|
|
|
- If you expect the assets to be self-hosted when your website is published:
|
|
|
|
Keep the `_config.yml` options as follows:
|
|
|
|
```yml
|
|
# _config.yml
|
|
assets:
|
|
self_host:
|
|
enabled: true
|
|
```
|
|
|
|
And then update the GitHub Actions workflow in `.github/workflows/pages-deploy.yml`:
|
|
|
|
```diff
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
with:
|
|
+ submodules: true
|
|
```
|
|
|
|
## Versions
|
|
|
|
| Dependency | Version |
|
|
| :------------------------------------------------------- | --------: |
|
|
| [Clipboard][clipboard] | `2.0.11` |
|
|
| [Day.js][dayjs] | `1.11.13` |
|
|
| [Font Awesome Free][fontawesome] | `6.6.0` |
|
|
| [GLightbox][glightbox] | `3.3.0` |
|
|
| [Loading-attribute-polyfill][loading-attribute-polyfill] | `2.1.1` |
|
|
| [Mermaid][mermaid] | `11.0.2` |
|
|
| [Simple-Jekyll-Search][simple-jekyll-search] | `1.10.0` |
|
|
| [Tocbot][tocbot] | `4.29.20` |
|
|
|
|
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy
|
|
|
|
<!-- deps -->
|
|
|
|
[clipboard]: https://www.jsdelivr.com/package/npm/clipboard
|
|
[dayjs]: https://www.jsdelivr.com/package/npm/dayjs
|
|
[fontawesome]: https://fontawesome.com/download
|
|
[loading-attribute-polyfill]: https://www.jsdelivr.com/package/npm/loading-attribute-polyfill
|
|
[glightbox]: https://www.jsdelivr.com/package/npm/glightbox
|
|
[mermaid]: https://www.jsdelivr.com/package/npm/mermaid
|
|
[simple-jekyll-search]: https://www.jsdelivr.com/package/npm/simple-jekyll-search
|
|
[tocbot]: https://www.jsdelivr.com/package/npm/tocbot
|