Skip to content

Commit 9f62ae1

Browse files
committed
Update Readme
1 parent 3ddcd5f commit 9f62ae1

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

README.md

+24-30
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,23 @@
1-
# Minimal SvelteKit Site with Sanity Studio
1+
# Clean SvelteKit + Sanity app
22

3-
A streamlined starter template using [SvelteKit](https://kit.svelte.dev/) for the frontend and [Sanity](https://sanity.io/) for robust content management.
4-
5-
![Screenshot of the SvelteKit and Sanity starter template](https://cdn.sanity.io/images/fkfgfb3d/production/c2d160119421bb5059b5e9229e7afa5ab6acfc1b-833x467.png?auto=format)
3+
This template includes a [SvelteKit](https://svelte.dev/docs/kit/introduction) app with a [Sanity Studio](https://www.sanity.io/) – an open-source React application that connects to your Sanity project’s hosted dataset. The Studio is configured locally and can then be deployed for content collaboration.
64

75
## Features
86

9-
* Fetch content seamlessly with [Sanity Content Lake](https://www.sanity.io/docs/datastore).
10-
* Render beautiful block content using [Portable Text](https://www.sanity.io/docs/presenting-block-text).
11-
* Manage and create content with the intuitive [Sanity Studio](https://www.sanity.io/docs/sanity-studio).
12-
* Live visual editing through [Sanity's Presentation tools](https://www.sanity.io/docs/presentation).
13-
* Advanced image cropping and rendering via [Sanity Image URLs](https://www.sanity.io/docs/image-url).
7+
- Fetch content seamlessly with [Sanity Content Lake](https://www.sanity.io/docs/datastore).
8+
- Render beautiful block content using [Portable Text](https://www.sanity.io/docs/presenting-block-text).
9+
- Manage and create content with the intuitive [Sanity Studio](https://www.sanity.io/docs/sanity-studio).
10+
- Live visual editing through [Sanity's Presentation tools](https://www.sanity.io/docs/presentation).
11+
- Advanced image cropping and rendering via [Sanity Image URLs](https://www.sanity.io/docs/image-url).
1412

1513
## Demo
1614

17-
[Try the live demo](https://sanity-template-sveltekit-clean.sanity.build/)
15+
https://sanity-template-sveltekit-clean.sanity.build
1816

1917
## Getting Started
2018

21-
### Prerequisites
22-
23-
* [Node.js](https://nodejs.org/en/) (v18.13 or later)
24-
* [Sanity CLI](https://www.sanity.io/docs/getting-started-with-sanity-cli) (optional)
25-
2619
### Install the template
2720

28-
This template includes a SvelteKit app and a Sanity Studio – an open-source React application that connects to your project’s hosted dataset. The Studio is configured locally and then deployed for content collaborators. Content and assets from the hosted dataset can be queried from Sanity’s APIs.
29-
3021
#### 1. Initialize template with Sanity CLI
3122

3223
Run the command in your Terminal to initialize this template on your local computer.
@@ -52,29 +43,32 @@ Open the SvelteKit app running locally in your browser on [http://localhost:5173
5243
Open the Studio running locally in your browser on [http://localhost:3333](http://localhost:3333). You should now see a screen prompting you to log in to the Studio. Use the same service (Google, GitHub, or email) that you used when you logged in to the CLI.
5344

5445
### Adding content with Sanity
55-
The template comes pre-defined with a schema containing a `Post` document type.
5646

47+
#### 1. Publish your first document
48+
49+
The template comes pre-defined with a schema containing a `Post` document type.
5750

58-
#### Publish your first document
5951
From the Studio, click "+ Create" and select the `Post` document type. Go ahead and create and publish the document.
6052

61-
Your content should now appear in your SvelteKit app ([http://localhost:3000](http://localhost:3000)) as well as in the Studio on the "Presentation" Tab
53+
Your content should now appear in your SvelteKit app ([http://localhost:5173](http://localhost:5173)) as well as in the Studio on the "Presentation" Tab
54+
55+
#### 2. Extending the Sanity schema
6256

63-
#### Extending the Sanity schema
6457
The schema for the `Post` document type is defined in the `studio/src/schemaTypes/post.ts` file. You can [add more document types](https://www.sanity.io/docs/schema-types) to the schema to suit your needs.
6558

6659
### Deploying your application and inviting editors
67-
Your SvelteKit frontend (`/sveltekit-app`) and Sanity Studio (`/studio`) are still only running on your local computer. It's time to deploy and get it into the hands of other content editors.
6860

69-
#### Deploy Sanity Studio
61+
#### 1. Deploy Sanity Studio
62+
63+
Your SvelteKit frontend (`/sveltekit-app`) and Sanity Studio (`/studio`) are still only running on your local computer. It's time to deploy and get it into the hands of other content editors.
7064

7165
Back in your Studio directory (`/studio`), run the following command to deploy your Sanity Studio.
7266

7367
```shell
7468
npx sanity deploy
7569
```
7670

77-
#### Deploy SvelteKit app to Vercel
71+
#### 2. Deploy SvelteKit app to Vercel
7872

7973
You have the freedom to deploy your SvelteKit app to your hosting provider of choice. With Vercel and GitHub being a popular choice, we'll cover the basics of that approach.
8074

@@ -83,15 +77,15 @@ You have the freedom to deploy your SvelteKit app to your hosting provider of ch
8377
3. Set the `Root Directory` to your SvelteKit app.
8478
4. Configure your Environment Variables.
8579

86-
#### Invite a collaborator
80+
#### 3. Invite a collaborator
81+
8782
Now that you’ve deployed your SvelteKit application and Sanity Studio, you can optionally invite a collaborator to your Studio. Open up [Manage](https://www.sanity.io/manage), select your project and click "Invite project members"
8883

8984
They will be able to access the deployed Studio, where you can collaborate together on creating content.
9085

91-
9286
## Resources
9387

94-
* [SvelteKit Documentation](https://svelte.dev/docs/kit/introduction/)
95-
* [Sanity.io Documentation](https://www.sanity.io/docs/)
96-
* [Portable Text Guide](https://www.sanity.io/docs/presenting-block-text)
97-
* [Join the Sanity Community](https://slack.sanity.io)
88+
- [Sanity documentation](https://www.sanity.io/docs/)
89+
- [SvelteKit documentation](https://svelte.dev/docs/kit/introduction/)
90+
- [Join the Sanity Community](https://slack.sanity.io)
91+
- [Learn Sanity](https://www.sanity.io/learn)

0 commit comments

Comments
 (0)