UNPKG

@nera-static/plugin-canonical-links

Version:

A plugin for Nera static site generator to create canonical links in to be used in the head.

github.com/seebaermichi/nera-plugin-canonical-links

seebaermichi/nera-plugin-canonical-links

155 lines (107 loc) β€’ 3.43 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# @nera-static/plugin-canonical-links A plugin for the [Nera](https://github.com/seebaermichi/nera) static site generator to generate canonical and alternate `<link>` tags for SEO in the document `<head>`. Helps search engines correctly index content across domains and languages. ## ✨ Features - Adds `<link rel="canonical">` for SEO - Supports multilingual alternate links - Easy Pug template integration - Configurable origin and slug mapping ## πŸš€ Installation Install the plugin in the root of your Nera project: ```bash npm install @nera-static/plugin-canonical-links ``` Then create a config file in your project’s `config/` directory: ``` config/ └── canonical-links.yaml ``` Nera will automatically detect the plugin and apply it during the build. ## βš™οΈ Configuration Create `config/canonical-links.yaml`: ```yaml app_origin: https://your-domain.com page_identifier: slug available_languages: - en - es - fr ``` - `app_origin`: The canonical base URL (overrides `app.origin`). - `page_identifier`: Shared key to match localized versions (defaults to `slug`). - `available_languages`: List of supported language codes (used to create alternate links). ## πŸ“„ Usage in Templates Include the plugin’s view in your layout head: ```pug head include /node_modules/@nera-static/plugin-canonical-links/views/index ``` This will generate: ```html <link href="https://example.com/index.html" rel="canonical" /> <link href="https://example.com/es/index.html" hreflang="es" rel="alternate" /> <link href="https://example.com/fr/index.html" hreflang="fr" rel="alternate" /> ``` ## πŸ—‚οΈ Content Structure To use alternate links, provide a shared identifier (e.g., `slug`) across translations: ``` pages/ β”œβ”€β”€ index.md β”œβ”€β”€ es/ β”‚ └── index.md └── fr/ └── index.md ``` Example frontmatter for each: **pages/index.md** ```yaml lang: en slug: home ``` **pages/es/index.md** ```yaml lang: es slug: home ``` **pages/fr/index.md** ```yaml lang: fr slug: home ``` ## 🧩 Rendering Details The plugin provides a view file that includes two partials: - `views/index.pug` ```pug include partials/canonical-link include partials/alternate-links ``` - `views/partials/canonical-link.pug` ```pug if (meta.canonicalLink) link(href=meta.canonicalLink.href, rel=meta.canonicalLink.rel) ``` - `views/partials/alternate-links.pug` ```pug if (meta.alternateLinks && meta.alternateLinks.length > 0) each alternate in meta.alternateLinks link(href=alternate.href, hreflang=alternate.hreflang, rel=alternate.rel) ``` You can copy or customize these templates for full control. ## πŸ§ͺ Development ```bash npm install npm run test ``` Includes unit and integration tests using [Vitest](https://vitest.dev) and [Pug](https://pugjs.org). ## πŸ§‘β€πŸ’» Author Michael Becker [https://github.com/seebaermichi](https://github.com/seebaermichi) ## πŸ”— Links - [Plugin Repository](https://github.com/seebaermichi/nera-plugin-canonical-links) - [NPM Package](https://www.npmjs.com/package/@nera-static/plugin-canonical-links) - [Nera Static Site Generator](https://github.com/seebaermichi/nera) ## οΏ½ Compatibility - **Nera**: v4.1.0+ - **Node.js**: >= 18 - **Plugin API**: Uses `getMetaData()` for optimal performance ## οΏ½πŸ“¦ License MIT