@indent-oss/sanityio-referenced-by
Plugin to see which documents reference a particular document
referenced-by-sanityio.mov
Video Alt Text: Demonstration of the Referenced-by Plugin
Getting started
-
Have an existing Sanity.io Studio Project
-
Install
@indent-oss/sanityio-referenced-byplugin using the command line:- NPM
npm i @indent-oss/sanityio-referenced-by
- Yarn
yarn add @indent-oss/sanityio-referenced-by
-
Add
@indent-oss/sanityio-referenced-bytosanity.json"plugins":
// /sanity.json
"plugins": [
"@indent-oss/sanityio-referenced-by"
],
- Add
sanity-structure.jsreference tosanity.json"parts":
// /sanity.json
"parts": [
{
"name": "part:@sanity/desk-tool/structure",
"path": "./sanity-structure.js"
}
]
- Create and/or update
sanity-structure.jsin the root directory:
// /sanity-structure.js
import {ReferencedByView} from 'part:@indent-oss/sanityio-referenced-by'
import S from '@sanity/desk-tool/structure-builder'
export const getDefaultDocumentNode = () => {
return S.document().views([
S.view.form(),
S.view.component(ReferencedByView).title('Referenced by'),
])
}
export default () => S.list().title('Base').items(S.documentTypeListItems())
Please note that Sanity.io Studio requires a title as a property of S in the export default function, but title does not need to be 'Base' for the plugin to work.
- Run the Sanity.io Studio Project - "Referenced By" plugin tab appears
The example directory contains an example Sanity.io Studio project which has the @indent-oss/sanityio-referenced-by plugin already installed
Credits
Thank you to Devin Halladay: List Referring Documents (Backlinks) in Sanity
License
MIT © Indent Inc
27 Dec 31, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
22 Dec 15, 2022
8 Nov 25, 2022
3 Sep 13, 2022
25 Nov 10, 2022
40 Dec 27, 2022
8.5k Jan 1, 2023