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

Added 'yaml.customTags' to 'settings.json' example (#4723)

Browse Source 
* Add 'yaml.customTags' to 'settings.json' example

in 'Creating Your Site'

* Grammar edit

* Use code annotation
This commit is contained in:
TetraTheta 2022-12-10 20:18:47 +09:00 committed by GitHub
parent 6398ca9efe
commit 9827e261b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/creating-your-site.md
View File

@ -58,14 +58,21 @@ theme:
2. Add the schema under the `yaml.schemas` key in your user or 2. Add the schema under the `yaml.schemas` key in your user or
workspace [`settings.json`][settings.json]: workspace [`settings.json`][settings.json]:
``` json ``` { .json .annotate }
{ {
"yaml.schemas": { "yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
} },
"yaml.customTags": [ // (1)!
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
} }
``` ```
1. `yaml.customTags` part will be needed if you want to use and configure [Emojis](reference/icons-emojis.md).
=== "Other" === "Other"
1. Ensure your editor of choice has support for YAML schema validation. 1. Ensure your editor of choice has support for YAML schema validation.