Smily Websites Documentation

This website is built using Docusaurus, a modern static site generator optimized for documentation.

Overview

This repository contains the source code for the Smily websites documentation, including:

• Theme structure and templates
• Liquid tags, filters, and objects reference
• Examples and usage patterns

Getting Started

Prerequisites

• Node.js (version 20 or higher)
• pnpm

corepack enable

Installation

pnpm install

Local Development

pnpm start

This command starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

Build

pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Preview Build

pnpm serve

This command serves the built website locally for preview.

Search Functionality

This documentation site uses @easyops-cn/docusaurus-search-local for local search functionality without requiring external services.

The search configuration is defined in docusaurus.config.js and the search index is generated during pnpm build.

Documentation Structure

• /docs/reference/ - Templates, objects, tags, and filters

Deployment

This repository uses GitHub Actions to build and deploy the Docusaurus site to GitHub Pages. The workflow is configured in .github/workflows/deploy.yml.

Related Resources

• Smily API Documentation
• Smily Engineering Blog
• Smily.com