Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sanity/generate-help-url

sanity-io1.1mMIT3.0.0TypeScript support: included

Generates URLs to specific sections of the Sanity documentation

sanity, cms, headless, realtime, content, generate-help-url

readme

@sanity/generate-help-url

npm versionnpm bundle sizeBuild Status

Generates URLs to specific sections of the Sanity documentation.

Installation

npm install --save @sanity/generate-help-url

Usage

import {generateHelpUrl} from '@sanity/generate-help-url'

console.log(generateHelpUrl('form-builder-input-missing-required-prop'))

The above example generates a help URL that points to a help document with the id form-builder-input-missing-required-prop.

License

MIT © Sanity.io

changelog

Change Log

All breaking changes to this project will be documented in this file.

3.0.0

  • BREAKING: Switched from default to named export