https://github.com/stefanjudis/alex-js-contentful-ui-extension
A Contentful UI extension to check for insensitive writing
https://github.com/stefanjudis/alex-js-contentful-ui-extension
alexjs contentful language
Last synced: about 1 month ago
JSON representation
A Contentful UI extension to check for insensitive writing
- Host: GitHub
- URL: https://github.com/stefanjudis/alex-js-contentful-ui-extension
- Owner: stefanjudis
- License: mit
- Created: 2018-02-15T21:30:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-14T09:18:02.000Z (almost 7 years ago)
- Last Synced: 2025-04-06T04:58:39.484Z (about 1 month ago)
- Topics: alexjs, contentful, language
- Language: HTML
- Homepage:
- Size: 345 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alex-js-contentful-ui-extension
A UI extension to check for insensitive writing
A validation mechanism for insensitive language as [Contentful UI Extension](https://www.contentful.com/developers/docs/concepts/uiextensions/) using [Alex.js](http://alexjs.com/).
**Important:** Unfortunately there is no Alex.js script available publicly. This is why this UI-extension uses my hosted version of it.
```html
```
I don't mind anybody else using this version but relying on me here, means that I could break you UI-extension. **You might consider hosting your own version.**
## How it works
The UI-extension is available for `Boolean` types.
When installed the UI-extension will evaluate all fields of the entry it is included in with the type `Symbol` (short text) and `Text` (long text). Short text will be evaluated with `alex.text` and long text as it's mostly markdown in my case with `alex.markdown`.
I decided to not block publishing with this UI-extension because sometimes there are false-positives.
## Installation
```sh
git clone [email protected]:contentful-developer-relations/alex-js-contentful-ui-extension.git
cd alex-js-contentful-ui-extension
npm install
```
### Configure
Create a configuration file with your credentials for Contentful.
```sh
cp env.example .env
```
Open `.env` in a editor of your liking and add your Contentful space ID, and management token. [Learn how to obtain a token](https://www.contentful.com/developers/docs/references/authentication/#getting-an-oauth-token).
Load environment variables
```sh
source .env
```
### Create
```sh
npm run create
```
Create task will register the extension in your space on Contentful.
### Update
```sh
npm run update
```
Update task will upload the extension to your space on Contentful.
## License
Copyright © Stefan Judis
Licensed under the [MIT license](https://github.com/contentful/developer-relations/ui-country-select/blob/master/LICENSE).