UNPKG

sitemap-magnolia

Version:

Sitemap light module for Magnolia

123 lines (45 loc) • 2.41 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Magnolia-cms sitemap module Adds sitemap to your website in .html and .xml formats with ease. Sitemaps are used by search engines to better understand the structure of your website. ## Installation **Magnolia CLI** Run in Magnolia's folder: ```bash mgnl install sitemap-magnolia ``` **Git** Clone [magnolia sitemap](https://git.magnolia-cms.com/users/kraiskub/repos/sitemap/browse) repository into Magnolia's light modules folder. ## Usage To add sitemap page follows these steps: 1. Log in to your Magnolia website 2. Create page under your home page and use “Sitemap” template to this page 3. Sitemap was created in both .html and .xml formats for you. To preview sitemap navigate to url of the page you just created. **Example of sitemap urls for both formats** * https://www.my-site.com/sitemap.html - .html format * https://www.my-site.com/sitemap.xml - .xml format localhost: * localhost:8080/home/sitemap.html - .html format * localhost:8080/home/sitemap.xml - .xml format ## Configuration ### Exclude templates from indexing When excluding templates from indexing, each page on your site with this template will not be included in the sitemap. To exclude templates from indexing to sitemap open **your-project/light-modules/sitemap/includes/sitemap_macro.ftl** in your favourite IDE and locate this line of code: ```freemarker [#assign excludedTemplates = ['sitemap:pages/sitemap']] // Add names of templates you want to exclude to this array ``` ### Change url priorities in .xml format In .xml format of sitemap each url has a priority. Highest possible priority is 1, which is the root page. Every other "/" in the url descreases the priority by 0.1. **Example** * https://www.my-site.com - priority **1** * https://www.my-site.com/foo - priority **0.9** * https://www.my-site.com/foo/bar - priority **0.8** localhost: * localhost:8080 - priority **1** * localhost:8080/foo - priority **0.9** * localhost:8080/foo/bar - priority **0.8** To configure priority values open **your-project/light-modules/sitemap/templates/pages/sitemap-xml.ftl** in your favourite IDE and locate this line of code: ```freemarker [#assign priority = (9 - (slashCount?size - initialSlashCount))/10] // Adjust this algorithm to change priority values ``` ## License [MIT](https://choosealicense.com/licenses/mit/)