Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kentico/xperience-by-kentico-siteimprove
An integration with Siteimprove that allows users to check website and pages for issues directly from Xperience by Kentico
https://github.com/kentico/xperience-by-kentico-siteimprove
siteimprove-cms-plugin xperience-by-kentico xperience-by-kentico-labs
Last synced: 6 days ago
JSON representation
An integration with Siteimprove that allows users to check website and pages for issues directly from Xperience by Kentico
- Host: GitHub
- URL: https://github.com/kentico/xperience-by-kentico-siteimprove
- Owner: Kentico
- License: mit
- Created: 2023-08-04T21:05:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T16:43:33.000Z (2 months ago)
- Last Synced: 2024-12-02T17:52:00.035Z (2 months ago)
- Topics: siteimprove-cms-plugin, xperience-by-kentico, xperience-by-kentico-labs
- Language: C#
- Homepage:
- Size: 1.27 MB
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Xperience by Kentico Siteimprove
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) [](https://github.com/Kentico/repo-template/actions/workflows/ci.yml)
## About The Project
Xperience by Kentico Siteimprove integration allows users to check pages for issues directly from Xperience by Kentico.
## Getting Started
### Prerequisites
* Xperience by Kentico >= 26.0.0
### Installation
1. Add project reference
## Setup of CMS Plugin
By following the steps below, the integration setups automatically on the first startup.
1. In `Program.cs`, register services and map routes by adding
```cs
WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
...
builder.Services.AddKentico();
builder.Services.AddSiteimprove(builder.Configuration);
...
WebApplication app = builder.Build();
...
app.UseKentico();
app.UseSiteimprove();
```
1. In `Views/_ViewImports.cshtml`, add Tag Helper
```cs
@using Kentico.Xperience.Siteimprove
@addTagHelper *, Kentico.Xperience.Siteimprove
```
1. In `Views/Shared/_Layout.cshtml`, place the Tag Helper to a suitable location
```cs
```
1. In your `appsettings.json`, add section
```json
"xperience.siteimprove": {
"APIUser": "",
"APIKey": "",
"EnableContentCheck" : "" // set this to true if you are subscribed to Prepublish feature
}
```
### Setup of CMS Deeplink
1. In `Program.cs`, register services by adding
```cs
WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
...
builder.Services.AddKentico();
builder.Services.AddSiteimprove(builder.Configuration);
```
1. In `Views/_ViewImports.cshtml`, add Tag Helper
```cs
@using Kentico.Xperience.Siteimprove
@addTagHelper *, Kentico.Xperience.Siteimprove
```
1. In `Views/Shared/_Layout.cshtml`, place the Tag Helper inside the head tag
```cs
```
## Usage
### CMS Plugin
The plugin is accessible only from Preview mode in the Pages application.
Pages are automatically rechecked when republished to ensure the plugin displays up-to-date information.
### CMS Deeplink
Meta tag is added to the head of each page to allow for easier setup of CMS Deeplink on Siteimprove's side. The meta tag follows pattern recommended by Siteimprove:
```html
```
## Contributing
For Contributing please see [`CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [`CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md)
### Requirements
* [.NET 7+ SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
## License
Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
## Support
This contribution has __Kentico Labs limited support__.
See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) for more information.
For any security issues see [`SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md).