Website logo
⌘K
Introduction
PORTAL
Agency Whitelabelling
PAGES
Pages - Accessing Page Data
Pagination Layouts
Page Templates
FORMS
CATEGORIES
Filtering WebApps and Modules by Categories
Outputting Categories on WebApp / Module / eCommerce Layouts
Outputting Category Fields in any Location
Category Detail Layouts
FAQ - Categories
COMPANY INFORMATION
Company Information
SITE SEARCH
Site Search
PUBLIC API/ZAPIER
Zapier - Formatting arrays correctly
Public API/Zapier Changelog
MODULES
Module Marketplace
Building Custom Modules
Siteglide Modules
Front-end Submit Modules
DATA STRUCTURES
Creating WebApps from the CLI
Field Types
WEBAPPS
Front-end Submit WebApps
Layouts
Search and Filtering
Understanding Custom Field Names and IDs
FAQ - WebApps
CRM
User Details
User Secure Zones
Storing User's Favourite WebApp / Module Items
User's Form Submissions (Cases)
How Users Edit their Email and Password Front End
Editing a User's CRM record Front End with Custom Field Sets
CLI
Introducing Siteglide CLI
CLI Changelog
Secure Zones with CLI
Page Templates with Siteglide CLI
Pages with Siteglide CLI
Includes with Siteglide CLI
Managing Email Templates
Migrate - Manual Form setup
Migrate - Convert existing Forms
Liquid
Accessing Assets
Liquid Dot Notation
Using WebApp Collections- Tutorial
Using the current_user object with Secure Zones
Preventing Duplicate Content with Query Parameters- Canonical URL and Robots.txt
FAQ - Liquid
GraphQL
Tutorial Overview
About GraphQL
Tutorial 1- Your First Query
Tutorial 2 - Pagination
Tutorial 3 - Filtering the Results
Tutorial 3 - Answers to the First Filtering Challenge
Tutorial 4 - Advanced Filtering
Tutorial 4 - Challenge Answers
Tutorial 5 - Using Liquid to run GraphQL queries on your Site
Tutorial 6 - Variables
Tutorial 6 - Answers to the Variables Challenge
Tutorial 7 - Sorting
Tutorial 8 - Building a Liquid API GET Endpoint Page powered by GraphQL queries
Best Practice and Performance
Module/WebApp Caching
Getting Started with Liquid Caching - to Reduce Server Response time and Improve Performance
Includes
ecommerce/basic_payment
ecommerce/checkout_standard
Frequently Asked Questions
How do I control Timezones?
Using Liquid Logic to Check if a field exists, or is empty on the Front End
How do I learn more about Liquid?
How to setup a multi domain start page
Docs powered by Archbee
CLI

Includes with Siteglide CLI

2min

Includes are all of the following: Code Snippet, Content Section, Header, Footer.

Code Snippets must be stored within the following file path of your project: marketplace_builder/views/partials/includes/code_snippet/ and must be .liquid file type.

Content Sections must be stored within the following file path of your project: marketplace_builder/views/partials/includes/content_section/ and must be .liquid file type.

Headers must be stored within the following file path of your project: marketplace_builder/views/partials/includes/header/ and must be .liquid file type.

Footers must be stored within the following file path of your project: marketplace_builder/views/partials/includes/footer/ and must be .liquid file type.

Example

This is an example Include generated by Siteglide. Below, we'll list available YML parameters, and body content.

YAML
---
metadata:
    id: 1
    name: Main Section
    file_type: content_section
physical_file_path: views/partials/includes/content_section/1.liquid
---
<!-- INCLUDE CONTENT HERE -->


Parameters

metadata

  • id  - Used by UI to reference Includes. Must be unique in the scope of that Include type (i.e. you could have ID=1 for both a Header and Footer) (required)
  • name - Include name shown in UI (required)
  • file_type - Used to define where the Include shows in UI.
    • Options: code_snippet, content_section, header, footer (required)
  • last_edit - timestamp of last edit - shown in UI

physical_file_path  - Files should be stored in a location relative to their ID and file_type. If your ID is '3', and file_type is 'header', then the physical_file_path would be views/partials/includes/header/3.liquid

Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Pages with Siteglide CLI
NEXT
Managing Email Templates
Docs powered by Archbee
TABLE OF CONTENTS
Example
Parameters
Docs powered by Archbee