Skip to content

bukinoshita/alex-api

Repository files navigation

Alex

Catch insensitive, inconsiderate writing.

Build Status Coverage Status

Whether your own or someone else’s writing, alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing in text.

For example, when We’ve confirmed his identity is given to alex, it will warn you and suggest using their instead of his.

Why

  • Helps to get better at considerate writing
  • Catches many possible offenses
  • Suggests helpful alternatives
  • Reads plain-text, HTML, and markdown as input
  • Stylish

API

URL: https://alex-api.now.sh

?text=${text}

Type: string
Required

Example

curl -X GET \
  'https://alex-api.now.sh?text=The%20slaves%20were%20read-only%20copies%20of%20master.%20But%20not%20to%20worry,%20he%20was%20a%20cripple.' \
  -H 'Content-Type: application/json' \
  -H 'Host: alex-api.now.sh' \

Integrations

Support

alex checks for many patterns of English language, and generates warnings for:

  • Gendered work-titles, for example warning about garbageman and suggesting garbage collector instead
  • Gendered proverbs, such as warning about like a man and suggesting bravely instead, or suggesting courteous for ladylike.
  • Blunt phrases, such as warning about cripple and suggesting person with a limp instead
  • Intolerant phrasing, such as warning about using master and slave together, and suggesting primary and replica instead
  • Profanities, the least of which being butt

See retext-equality and retext-profanities for all checked rules.

alex ignores words meant literally, so “he”, He — ..., and the like are not warned about

License

MIT © Bu Kinoshita