# @sanity/generate-help-url

> Generates URLs to specific sections of the Sanity documentation

Latest version **4.0.0** (published 2026-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sanity/generate-help-url
pnpm add @sanity/generate-help-url
yarn add @sanity/generate-help-url
bun add @sanity/generate-help-url
```

## Health

**Score 70/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2026-01-09 |
| First published | 2016-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Author | Sanity.io |
| Maintainers | kmelve, bjoerge, rexxars, skogsmaskin, tonina, mattcraig, joneidejohnsen, rubioz, robinpyon, mariuslundgard, sanity-io, irina937, evenw, radhe_sanity, rbotten, danielsgroves, judofyr, ryanblock, obliadp, dcilke, madken, fredcarlsen, hermanw, tambet, sgulseth, atombender, stipsan, snorreeb, sanity-svc.npm, rankers, rdunk, michael-sanity, vincentquigley, ritasdias, pete-garnett-sanity, kenjonespizza, josh_sanity_io, cngonzalez-sanity, jjburbridge, tdfka_rick, ryanbonial-sanity, indrek.karner, ash, sergeisarviro, refiito, drewsanity, kaspar.lippmaa.sanity, dam, simen.svale, tbeseda, daniel.malmer, jordanl17, colepeters, armandocerna, joan_miralles_paez, christianhg, pedro-sanity, jwoods-sanity, binoy14, pauloborgesf, ausha, chrislarocquesanity, tnaughts1, alexjmold-sanity, jason.brown, rostimelk, mdinning, mattlewine.sanity, msfragala, adoprog, tonysanity, u269c, bramdo_, samhem, betson, georgedoescode, macdonst, eoinsanity, dashedstripes, jmswrnr, snocorp_sanity, mmgj, filmaj, gu-stav, mads.mogenshoj, sanitytom, sanity-cb, sanitykev, victor.ayogu, ryanbethel_sanity, brianleroux, johnsicili, p10e, krlund, jonahsnider, mwritter, torbratsbergsanity, evelinawahlstrom, jw-sanity, bobinska.dev, oleg1357, josef-sanity, gabe.wyatt, kbrabrand, annez-sanity, sanityjamie, laurenashpolesanity, geoffball, carsten.schwesig, fishstix81 |
| Keywords | sanity, cms, headless, realtime, content, generate-help-url |

## Links

- npm: https://www.npmjs.com/package/@sanity/generate-help-url
- Repository: https://github.com/sanity-io/generate-help-url
- Homepage: https://github.com/sanity-io/generate-help-url#readme
- Issues: https://github.com/sanity-io/generate-help-url/issues
- npm.io page: https://npm.io/package/@sanity/generate-help-url

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 4.0.0 (latest) — 2026-01-09
- 2.25.5-next.6 (next) — 2022-01-31
- 2.25.1-feature-image-file-input-refactor.150 (feature-image-file-input-refactor) — 2022-01-24
- 2.24.3-new-image-file-input.118 (new-image-file-input) — 2022-01-18
- 2.24.3-pte.128 (pte) — 2022-01-18
- 2.24.1-fix-graphql-deploy.6 (fix-graphql-deploy) — 2022-01-17
- 2.23.5-fix-search-issue.1 (fix-search-issue) — 2022-01-07
- 2.23.3-canary.84 (canary) — 2021-12-22
- 2.23.3-field-groups.29 (field-groups) — 2021-12-22
- 2.22.5-reference-updates.85 (reference-updates) — 2021-12-03
- 2.21.12-shopify.7 (shopify) — 2021-11-12
- 2.21.10-pte-sanity-ui.285 (pte-sanity-ui) — 2021-11-04
- 2.21.5-fix-annotation-remove-bug.7 (fix-annotation-remove-bug) — 2021-10-19
- 2.18.1-pane-components.147 (pane-components) — 2021-09-10
- 2.17.3-styled-peer-dep.18 (styled-peer-dep) — 2021-09-04
- … 534 more at https://npm.io/package/@sanity/generate-help-url/versions

## README

# @sanity/generate-help-url

[![npm version](https://img.shields.io/npm/v/@sanity/generate-help-url.svg?style=flat-square)](https://www.npmjs.com/package/@sanity/generate-help-url)[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@sanity/generate-help-url?style=flat-square)](https://bundlephobia.com/result?p=@sanity/generate-help-url)[![Build Status](https://img.shields.io/github/workflow/status/sanity-io/generate-help-url/test/main.svg?style=flat-square)](https://github.com/sanity-io/generate-help-url/actions?query=workflow%3Atest)

Generates URLs to specific sections of the Sanity documentation.

## Installation

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

## Usage

```ts
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](https://www.sanity.io/)

---
_Source: https://npm.io/package/@sanity/generate-help-url · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._