https://github.com/web3templates/sandocs-template
Sandocs Documentation Starter Website Template built with Next.js, TailwindCSS & Sanity CMS
https://github.com/web3templates/sandocs-template
alternative docs docsaurus documentation gitbook help-center knowledge-base plugin sandocs starter template web3templates
Last synced: about 1 month ago
JSON representation
Sandocs Documentation Starter Website Template built with Next.js, TailwindCSS & Sanity CMS
- Host: GitHub
- URL: https://github.com/web3templates/sandocs-template
- Owner: web3templates
- License: gpl-3.0
- Created: 2022-07-18T16:01:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-26T07:45:12.000Z (over 1 year ago)
- Last Synced: 2025-02-26T08:34:14.970Z (over 1 year ago)
- Topics: alternative, docs, docsaurus, documentation, gitbook, help-center, knowledge-base, plugin, sandocs, starter, template, web3templates
- Language: JavaScript
- Homepage: https://sandocs.vercel.app
- Size: 2.96 MB
- Stars: 78
- Watchers: 3
- Forks: 36
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⚠️❗ _This repo is archived. It is no longer maintained. A better version will be released soon_ ⚠️❗
---
# Sandocs Documentation Template
Sandocs is a JAMStack Documentation, Knowledge Base & Help Center Template built with Next.js, Tailwind CSS & Sanity CMS built by [Web3Templates](https://web3templates.com/).
[Click here to see live demo →](https://sandocs.vercel.app/)
###### Click the above button for one-click clone & deploy for this template. Read [quick start](#quick-start) guide below.
#### Template Preview
## Sandocs - Pro Version
Pro version is available to purchase on https://web3templates.com which includes:
- The Landing Page
- Dark Mode
- Remove Backlink
- Personal License
- 6 Months Support
## Quick Start
To use this template and configure sanity and deploying to vercel, we recommend the "One Click Deploy" method. Just follow the GUI and you will have an exact copy of what you see in the live demo .Using this method will automatically configure the following tasks for you.
- Signup/Login to Sanity CMS (if not already)
- Create a Sanity Project
- Add required CORS & API settings in the project
- Create new Repository in Github
- Install Sanity Integration in Vercel
- Add required `.env` variables
- Deploy Sanity Studio - Content Manager
- Import Demo Content (as seen in live demo)
- Deploy to Vercel
To setup one click deployment, click the above link below and follow the steps.
## Local Development
Again, we recommend you to use the one-click deploy first which will create a github repo. You can then clone the github repo to your local system and change following `.env` variables.
1. ~root/`.env.local`
Change `.env.local.example` placed in the root folder and rename it to `.env.local` and add your sanity project ID. Get it from https://sanity.io/manage
```
NEXT_PUBLIC_SANITY_PROJECT_ID=xxyyzz
```
2. `/studio/.env.development` or `/studio/sanity.json`
To develop sanity cms locally, you also need to add the Project ID and Dataset in either `.env` or in `sanity.json` file.
```
# .env.development
SANITY_STUDIO_API_PROJECT_ID=xxyyzz
SANITY_STUDIO_API_DATASET=production
```
or you can directly replace the project ID in the `/studio/sanity.json`
```js
// sanity.json
// ...
"api": {
"projectId": "xxyyzz",
"dataset": "production"
},
// ...
```
### Copy Demo Content
Before running this template, make sure you add your content or upload demo content provided by this template. Make sure `@sanity/cli` is installed globally.
Demo data is available in `.sanity-template/data/production.tar.gz`. Checkout [Sanity docs](https://www.sanity.io/docs/importing-data#d183adde8ef9) to import demo data instructions.
### Run Next.js frontend
You can use the normal Next.js method to run the frontend. Just run the following command and a live server will open on `http://localhost:3000`
```
yarn dev
```
### Run Sanity Studio CMS
1. Install Sanity CLI globally (if not already)
```
npm install -g @sanity/cli
```
2. Run
To run sanity studio server, run the following command in your terminal. It will open a live server on `http://localhost:3333`
```
yarn sanity
# or
cd studio && sanity start
```