File tree 1 file changed +11
-2
lines changed
1 file changed +11
-2
lines changed Original file line number Diff line number Diff line change @@ -37,13 +37,22 @@ This will create the following structure:
37
37
38
38
### Minimal configuration
39
39
40
- Simply add the following lines to ` mkdocs.yml ` to enable the theme:
40
+ Simply set the ` site_name ` and add the following lines to ` mkdocs.yml ` to enable the theme:
41
41
42
- ``` yaml
42
+ ``` yaml hl_lines="2-5"
43
+ site_name : My site
44
+ site_url : https://mydomain.org/mysite
43
45
theme :
44
46
name : material
45
47
` ` `
46
48
49
+ The ` site_url` setting is important for a number of reasons.
50
+ By default, MkDocs will assume that your site is hosted at the root of
51
+ your domain. This is not the case, for example, when [publishing to GitHub
52
+ pages] - unless you use a custom domain. Another reason is that some of the
53
+ plugins require the `site_url` to be set, so you should always do this.
54
+
55
+ [publishing to GitHub pages] : publishing-your-site.md#github-pages
47
56
[installation methods] : getting-started.md#installation
48
57
49
58
???+ tip "Recommended : [configuration validation and auto-complete]"
You can’t perform that action at this time.
0 commit comments