Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 1.94 KB

README.md

File metadata and controls

76 lines (51 loc) · 1.94 KB
Raw

sane-eleventy Prerequisite Prerequisite

Repo template for Sanity + Eleventy projects at Self Aware

📖 About

  • Templates are authored in the templates directory using any template language supported by eleventy (Nunjucks by default)
  • Eleventy global data files live in data.
  • Styles are authored using Tailwind and the entry point lives in styles. We always leverage Tailwind utilities before resorting to adding custom styles.
  • JavaScript lives in scripts
  • Place any static files in the public folder
  • Netlify serverless functions are authored in api
  • Place any eleventy related utilities in lib
  • Sanity Studio lives in the studio directory

✨ Install

# Install Yarn
npm i -g yarn

# Install project dependencies using yarn
yarn

# Install Sanity Studio dependencies using yarn
cd studio && yarn

👩🏻‍💻 Usage

To set up with Sanity, you will need to set your Sanity projectId and dataset in two places:

  1. studio/sanity.json
  2. lib/sanity.js

Development

# Start Netlify dev server
yarn dev

# Start Sanity dev server
cd studio && yarn start

Production

# Build front-end for production
yarn build

Deployment

Deploy the front-end using Netlify

# Deploy Sanity Studio
cd studio && yarn deploy

🖼️ Showcase

The following sites are powered by sane-eleventy:

💡 Inspiration

Thanks to sane-shopify for the name inspiration 🙂

🧾 License

MIT