README.md

sane-eleventy

Repo template for Sanity + Eleventy projects at Self Aware

📖 About

• Eleventy front-end lives in the web directory
• Templates are authored in the web/src/templates directory using any template language supported by eleventy (Nunjucks by default)
• Eleventy global data files live in web/src/data.
• Styles are authored using Sass and live in web/src/styles. Our utility-first styling library, wool is included by default and can be configured via web/src/styles/_config.scss
• JavaScript lives in web/src/scripts
• Place font and favicon files in their respective folders in web/src/assets.
• Netlify serverless functions are authored in web/src/functions
• Place any eleventy related utilities in web/src/util
• Sanity Studio lives in the studio directory

✨ Install

# Ensure correct Node and NPM versions are installed using NVM
nvm install

# Install Yarn
npm i -g yarn

# Install project dependencies using yarn
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. web/src/util/client.js

Development

# Start Netlify dev server
yarn dev

# Start Sanity dev server
yarn start:studio

Production

# Build front-end for production
yarn build

Deployment

# Deploy front-end using Netlify CLI
yarn add netlify-cli -g
netlify init
netlify deploy

# Deploy Sanity Studio
yarn deploy:studio

🖼️ Showcase

The following sites are powered by sane-eleventy:

• Off Season
• MIT Digital Humanities
• More coming soon!

💡 Inspiration

Thanks to sane-shopify for the name inspiration 🙂

🧾 License

MIT