97d95fdb5e
Updates the requirements on [mermaid](https://github.com/mermaid-js/mermaid) and [tocbot](https://github.com/tscanlin/tocbot) to permit the latest version. Updates `mermaid` to 10.6.0 - [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.5.0...v10.6.0) Updates `tocbot` to 4.21.3 - [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.21.2...v4.21.3) --- updated-dependencies: - dependency-name: mermaid dependency-type: direct:production dependency-group: npm - dependency-name: tocbot dependency-type: direct:production dependency-group: npm ... Signed-off-by: dependabot[bot] <support@github.com>
78 lines
2.5 KiB
Markdown
78 lines
2.5 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 |
|
|
| :------------------------------------------------------- | --------: |
|
|
| [Bootstrap][bootstrap] | `5.3.2` |
|
|
| [Clipboard][clipboard] | `2.0.11` |
|
|
| [Day.js][dayjs] | `1.11.10` |
|
|
| [Font Awesome Free][fontawesome] | `6.4.2` |
|
|
| [jQuery][jquery] | `3.7.1` |
|
|
| [Loading-attribute-polyfill][loading-attribute-polyfill] | `2.1.1` |
|
|
| [Magnific Popup][magnific-popup] | `1.1.0` |
|
|
| [Mermaid][mermaid] | `10.6.0` |
|
|
| [Simple-Jekyll-Search][simple-jekyll-search] | `1.10.0` |
|
|
| [Tocbot][tocbot] | `4.21.3` |
|
|
|
|
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy
|
|
|
|
<!-- deps -->
|
|
|
|
[bootstrap]: https://www.jsdelivr.com/package/npm/bootstrap
|
|
[clipboard]: https://www.jsdelivr.com/package/npm/clipboard
|
|
[dayjs]: https://www.jsdelivr.com/package/npm/dayjs
|
|
[fontawesome]: https://fontawesome.com/download
|
|
[jquery]: https://www.jsdelivr.com/package/npm/jquery
|
|
[loading-attribute-polyfill]: https://www.jsdelivr.com/package/npm/loading-attribute-polyfill
|
|
[magnific-popup]: https://www.jsdelivr.com/package/npm/magnific-popup
|
|
[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
|