Documentation

This commit is contained in:
squidfunk 2022-09-18 16:03:45 +02:00
parent 6bd88485d2
commit fc0e4fe611

View File

@ -95,72 +95,46 @@ The following configuration options are available:
cards_font: Roboto
```
!!! tip "Limitations of the default `Roboto` font"
The default font value `Roboto` has no support to CJK languages,
if you tend to have these characters in your page's title,
or your `site_name` and `site_description` is containing CJK letters,
you may switch to Noto family (`Noto Sans` or `Noto Serif`) which provides support to CJK languages, to avoid render error.
!!! question "Why do social cards render boxes for CJK languages?"
Some fonts do not contain CJK characters, like for example the
[default font, `Roboto`][font.text]. In case your `site_name`,
`site_description`, or [page title] contain CJK characters, choose
another font from [Google Fonts] which comes with CJK characters, e.g.
one from the `Noto Sans` font family:
=== "Chinese (Simplified)"
=== "Simplified Chinese"
=== "Sans Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Sans SC
```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif SC
```
=== "Chinese (Traditional)"
=== "Traditional Chinese"
=== "Sans Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Sans TC
```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif TC
```
=== "Japanese"
=== "Sans Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Sans JP
```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif JP
```
=== "Korean"
=== "Sans Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Sans KR
```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif KR
```
[`cards_dir`](#+social.cards_dir){ #+social.cards_dir }
: :octicons-milestone-24: Default: `assets/images/social` This option
@ -181,6 +155,7 @@ The following configuration options are available:
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords
[Google Fonts]: https://fonts.google.com
[page title]: ../reference/index.md#setting-the-page-title
#### Dependencies