Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pjlamb12/scully-plugin-canonical
Set the canonical link href for Scully pages that have that in the route data
https://github.com/pjlamb12/scully-plugin-canonical
Last synced: 12 days ago
JSON representation
Set the canonical link href for Scully pages that have that in the route data
- Host: GitHub
- URL: https://github.com/pjlamb12/scully-plugin-canonical
- Owner: pjlamb12
- License: mit
- Created: 2020-12-12T22:08:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-14T06:12:25.000Z (almost 4 years ago)
- Last Synced: 2024-12-10T23:30:27.004Z (26 days ago)
- Language: TypeScript
- Size: 335 KB
- Stars: 0
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[]()
[]()
[]()
[](https://github.com/prettier/prettier)
[](#contributors-)
# Scully Canonical Plugin
The purpose of the Scully canonical plugin is to take a canonical link attribute from a route and replace the value of the canonical link in the head of a page, or add the link tag if it doesn't exist. This is needed for SEO purposes, if a given article was first published on another site, for example.
## Features
- ✅ Replaces the canonical link with the provided URL for the link tag
- ✅ Adds a canonical link tag if one doesn't exist for a page
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [FAQ](#faq)
## Installation
### NPM
`npm install scully-plugin-canonical --save-dev`
### Yarn
`yarn add scully-plugin-canonical --dev`
## Usage
Render plugins get access to information about the route, and the plugin looks for the title in the following locations in order:
- `route.canonical`
- `route.data.canonical`
- `route.canonicalUrl`
- `route.data.canonicalUrl`
- `route.canonical_url`
- `route.data.canonical_url`
> If the canonical url is set in the frontmatter of a markdown file, the attribute shows up on `route.data`.
To use this plugin, you need to just require the package inside the Scully `config.ts` for your project, i.e. `scully.your-project-name.config.ts`. After requiring the plugin, add it to the `defaultPostRenderers` array for the site:
```ts
// scully.your-project-name.config.ts
require('scully-plugin-canonical');
export const config: ScullyConfig = {
projectRoot: './src',
projectName: 'your-project-name',
outDir: './dist/static',
routes: {},
defaultPostRenderers: ['setCanonicalLinkPlugin'],
};
```
If you only want it to be added to some routes, add it like this:
```ts
// scully.your-project-name.config.ts
require('scully-plugin-canonical');
export const config: ScullyConfig = {
...
routes: {
'/blog/:slug': {
type: 'contentFolder',
slug: {
folder: './blog'
},
postRenderers: ['setCanonicalLinkPlugin']
}
}
...
};
```
That's all it takes for the plugin to be included and run on the pages in your app.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Logo Attribution
