File tree 2 files changed +36
-1
lines changed
2 files changed +36
-1
lines changed Original file line number Diff line number Diff line change @@ -92,6 +92,41 @@ slightly different:
92
92
[ mkdocs_theme.yml ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/mkdocs_theme.yml
93
93
[ custom theme guide ] : https://www.mkdocs.org/user-guide/custom-themes/#creating-a-custom-theme
94
94
95
+ ??? tip "Recommended: configuration validation and auto-complete"
96
+
97
+ In order to minimize friction and maximize productivity, Material for MkDocs
98
+ provides its own [schema.json] for `mkdocs.yml`. If your editor supports
99
+ YAML schema validation, it's definitely recommdended to set it up:
100
+
101
+ === "Visual Studio Code"
102
+
103
+ 1. Install [`vscode-yaml`][vscode-yaml] for YAML language support.
104
+ 2. Add the schema under the `yaml.schemas` key in your user or
105
+ workspace [`settings.json`][settings.json]:
106
+
107
+ ``` json
108
+ {
109
+ "yaml.schemas": {
110
+ "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
111
+ }
112
+ }
113
+ ```
114
+
115
+ === "Other"
116
+
117
+ 1. Ensure your editor of choice has support for YAML schema validation.
118
+ 2. Add the following lines at the top of `mkdocs.yml`:
119
+
120
+ ``` yaml
121
+ # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
122
+ ```
123
+
124
+
125
+ [ schema.json ] : schema.json
126
+ [ vscode-yaml ] : https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
127
+ [ settings.json ] : https://code.visualstudio.com/docs/getstarted/settings
128
+ [ LSP-yaml ] : https://github.com/sublimelsp/LSP-yaml
129
+
95
130
### Advanced configuration
96
131
97
132
Material for MkDocs comes with many configuration options. The setup section
Original file line number Diff line number Diff line change @@ -158,7 +158,7 @@ markdown_extensions:
158
158
159
159
# Page tree
160
160
nav :
161
- - Home : index.mds
161
+ - Home : index.md
162
162
- Getting started :
163
163
- Installation : getting-started.md
164
164
- Creating your site : creating-your-site.md
You can’t perform that action at this time.
0 commit comments