Skip to content

Kazuki-tam/pure-liquid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pure Liquid

Pure Liquid is a starter kit with Liquid for front-end projects. This starter kit focuses on building a static website and suits small to medium projects like a landing page and a corporate website.

Status

Release (latest by date) Issues Maintenance Release date

Features

  • Built-in static site generator
  • Breaking HTML smaller files with Liquid
  • HTML Validation with HTML-validate
  • Lint TypeScript files with ESLint
  • Lint SCSS files with Stylelint
  • Format code with prettier
  • Compress images
  • Creating SVG sprites
  • Built-in test runner with Jest and Playwright

Requirements

Main Dependencies

How to Use

Clone this repository and install dependencies

yarn install

Available Commands

Start your project in development mode

yarn start

Start your project in production mode

yarn serve

Build your project for development

yarn build

Build your project for production

yarn release

Lint your project files

yarn lint

Fix your project files

yarn lint:fix
Other support commands

Install missing TypeScript typings

yarn postInstall

Check the package's license

yarn checkLicense

Run unit testing.

yarn unit
yarn unit:watch

Run UI testing.

yarn e2e
yarn e2e:headed

Liquid

11ty generates HTML files from the Liquid template.

📖 Learn Liquid

Sass (Dart Sass)

You can manage style sheets logically with Sass.

📖 Learn Sass

TypeScript

This starter kit supports TypeScript. postInstall command will help you to install typings in this project.

📖 Learn TypeScript

Jest

Jest is built-in in this project. You can run Jest from the command line.

📖 Learn Jest

Playwright

Playwright enables reliable end-to-end testing.

📖 Learn Playwright

SVG sprites

Add SVG files into the icons folder.

src/assets/icon/

Call the icon with ID.

<svg class="icon" role="img">
  <use xlink:href="/assets/svg-sprite/svg-sprite.svg#sample"></use>
</svg>

Configurations

Configuration list

Recommended IDE

Contributes

Pull requests are always welcome.

License

MIT