# hello-sanity-studio

> Sanity plugin that helps you quickly set up a default Sanity Studio desk.

Latest version **0.7.1** (published 2023-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install hello-sanity-studio
pnpm add hello-sanity-studio
yarn add hello-sanity-studio
bun add hello-sanity-studio
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.1 |
| Published | 2023-04-28 |
| First published | 2023-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 103.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Murat Avcı |
| Maintainers | fr073n |
| Keywords | sanity-studio, sanity, starter, theme |

## Links

- npm: https://www.npmjs.com/package/hello-sanity-studio
- Repository: https://github.com/snowpact/hello-sanity-studio
- Homepage: https://github.com/snowpact/hello-sanity-studio#readme
- Issues: https://github.com/snowpact/hello-sanity-studio/issues
- npm.io page: https://npm.io/package/hello-sanity-studio

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@sanity/client](https://npm.io/package/@sanity/client.md) ^5.4.2
- [@sanity/groq-store](https://npm.io/package/@sanity/groq-store.md) ^2.1.0
- [@sanity/orderable-document-list](https://npm.io/package/@sanity/orderable-document-list.md) ^1.0.4

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.7.1 (latest) — 2023-04-28
- 0.7.0 — 2023-04-28
- 0.6.5 — 2023-04-27
- 0.6.4 — 2023-04-27
- 0.6.3 — 2023-04-27
- 0.6.2 — 2023-04-27
- 0.6.1 — 2023-04-27
- 0.6.0 — 2023-04-27
- 0.5.0 — 2023-04-27

## README

# Sanity Plugin: Hello Sanity

This is a non-official [Sanity](https://www.sanity.io/) plugin that helps you quickly set up a default Sanity Studio desk with base features such as **blog, projects, SEO, and landing pages**. It's centered around the "expertise" notion, allowing you to showcase your skills in a structured and organized way.

## Installation

To install this plugin, first, you need to add it to your Sanity Studio's package.json file:


```css
yarn add hello-sanity-studio
npm install hello-sanity-studio
```

Then, add the plugin to your Sanity Studio's `sanity.json` file:

```json
{
  "plugins": [
    "hello-sanity-studio"
  ]
}
```

Make sure to also install the "@sanity/code-input" dependency for this plugin to work properly:

```css
yarn add @sanity/code-input
npm install @sanity/code-input // if you need `initCodeBlocks`
```

## Setup

On `sanity.config.ts` please setup up this module like that :

```js
import {defineConfig} from 'sanity'
import {deskTool} from 'sanity/desk'
import {visionTool} from '@sanity/vision'
import {unsplashImageAsset} from 'sanity-plugin-asset-source-unsplash'

import {codeInput} from '@sanity/code-input'  // <- this is needed if you uses `initCodeBlocks`

import { HelloSanityStudio } from 'hello-sanity-studio'

const helloSanityStudio = new HelloSanityStudio({
  expertiseCategories,
  initCodeBlocks: false,
})

export default defineConfig({
  name: 'default',
  title: 'PROJECT_NAME',

  projectId: 'PROJECT_ID',
  dataset: 'PROJECT_DATASET',

  schema: {
    types: helloSanityStudio.getSchemaTypes(), // <- here
  },

  plugins: [
    codeInput(), // <- this is needed if you uses `initCodeBlocks`
    unsplashImageAsset(),
    deskTool({
      title: 'DESK_VIEW_TITLE',
       structure: (S, context) => {
        return S.list().title('Dashboard').items(helloSanityStudio.generateDesk(S, context))  // <- here
      },
    }),
    visionTool(),
  ],

  document: {
    actions: (input, context) => helloSanityStudio.filterOutSingletonActions(input, context), // <- here
  },
})
```

## Usage

Just run

```css
yarn dev
npm run dev
```

The Showcase Studio will help you create a structured and organized Sanity desk for showcasing your expertise. It includes the following features:

- Blog: A simple blog schema with fields for title, author, content, and publication date.
- Projects: A schema for showcasing your past projects with fields for title, description, technologies used, and an image.
- Landing Pages: Based on **expertise**, for creating landing pages with fields for title, content, image, and call-to-action button.

And you will have access to :
- SEO: A schema for defining meta tags, OG tags, and other SEO-related information for each page on your website.

## Contributing

If you find any bugs or issues with this plugin, please report them on the Github Issues page. Pull requests are also welcome!

## License

This plugin is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

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