Git Product home page Git Product logo

base-template's Introduction

Base Template

A minimal template for developers getting started with Squarespace, using developer mode. No tweaks, no web fonts, no static assets, no static pages, no system collections, no collection features, no modules at all.

For more information about the Squarespace Developer Platform see developers.squarespace.com.

Usage

See the Developer Getting Started page for an step-by-step guide for getting started with the Squaresapce Developer Platform. You can create a new website using this template by visiting base-template.squarespace.com and clicking the "Create a Site Like This" button. This template is also available on GitHub.

Squarespace Templates

Each Squarespace website is based on a template like this one. Templates contain regular web files like CSS and JavaScript. In addition, Squarespace recognizes a few special file types:

JSON-T Template Files

Squarespace template files are written in JSON Template, also known as JSON-T. It is a simple yet expressive template language. JSON-T files have different extensions depending on the type of file, for example .list, .item, and .region.

LESS Files

Template LESS files (.less) are processed through the LESS preprocessor. LESS extends CSS with dynamic behavior such as variables, mixins, operations and functions.

Template Folder Structure

Squarespace template files are organized using the following folder structure at the root of your site:

  • assets: design assets — example: images, fonts and icons
  • blocks: reusable blocks of JSON-T (AKA partials) — ex: navigation.block
  • collections: collection files — [collection].list, [collection].item, [collection].conf
  • scripts: Javascript files — site.js
  • styles: stylesheet files — styles.css, styles.less
  • [root]: sitewide files — site.region, template.conf

Essential Files

At the very minimum, your template needs a .region file and a template.conf.

/site.region

Typically this file is used as the global site template – containing the site header, footer, and sidebars. This is like the index.html of your site. Every template must have at least one .region file. Simple templates will have a single .region, more advanced templates will have multiple .region files describing header, body, and footer variants. Regions files live in the root directory of a template.

See the Layouts & Regions documentation for more details.

/template.conf

Contains the configuration settings for the template. This is where you can name your template, specify layouts, add navigation sections, specify stylesheets, and other general site options. Template configuration files must live in the root directory of a template.

See the Template Configuration documentation for more details.

Further Reading

For further reading please consult the Squarespace Template Overview and other documentation on the Squarespace developers website.

base-template's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.