OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-09-18 16:03:45 +02:00
parent 6bd88485d2
commit fc0e4fe611
1 changed files with 35 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
docs/setup/setting-up-social-cards.md
View File

@ -95,71 +95,45 @@ The following configuration options are available:
cards_font: Roboto cards_font: Roboto
``` ```
!!! tip "Limitations of the default `Roboto` font" !!! question "Why do social cards render boxes for CJK languages?"
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.
=== "Simplified Chinese" Some fonts do not contain CJK characters, like for example the
=== "Sans Serif Font" [default font, `Roboto`][font.text]. In case your `site_name`,
``` yaml `site_description`, or [page title] contain CJK characters, choose
plugins: another font from [Google Fonts] which comes with CJK characters, e.g.
- social: one from the `Noto Sans` font family:
cards_font: Noto Sans SC
``` === "Chinese (Simplified)"
=== "Serif Font" ``` yaml
``` yaml plugins:
plugins: - social:
- social: cards_font: Noto Sans SC
cards_font: Noto Serif SC ```
```
=== "Chinese (Traditional)"
=== "Traditional Chinese"
=== "Sans Serif Font" ``` yaml
``` yaml plugins:
plugins: - social:
- social: cards_font: Noto Sans TC
cards_font: Noto Sans TC ```
```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif TC
```
=== "Japanese" === "Japanese"
=== "Sans Serif Font"
``` yaml ``` yaml
plugins: plugins:
- social: - social:
cards_font: Noto Sans JP cards_font: Noto Sans JP
``` ```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif JP
```
=== "Korean" === "Korean"
=== "Sans Serif Font"
``` yaml ``` yaml
plugins: plugins:
- social: - social:
cards_font: Noto Sans KR cards_font: Noto Sans KR
``` ```
=== "Serif Font"
``` yaml
plugins:
- social:
cards_font: Noto Serif KR
```
[`cards_dir`](#+social.cards_dir){ #+social.cards_dir } [`cards_dir`](#+social.cards_dir){ #+social.cards_dir }
@ -181,6 +155,7 @@ The following configuration options are available:
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables [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 [CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords
[Google Fonts]: https://fonts.google.com [Google Fonts]: https://fonts.google.com
[page title]: ../reference/index.md#setting-the-page-title
#### Dependencies #### Dependencies