Add YAML schema for `mkdocs.yml`
Open
Nobody has claimed this yet.
dev: enhancement 🛠️✨
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
In settings.json add the following. The customTags only need to be added for emoji support, but provide an example of how to do so. Reference for emojis: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#configuration
"yaml.customTags": [
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
],
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
},
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open settings.json and compare the requested yaml.customTags and yaml.schemas entries with the MkDocs Material emoji configuration reference. Done means the schema points to mkdocs.yml and the emoji custom-tag example is included in settings.json.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100