Skip to content

xiw-project/xiwSS

Repository files navigation

xiwSS Logo

xiwSS dev-0.1.0

Meaningful. Accurate. Simple. Maximum Performance.

A part of the xiw Project


Overview

xiwSS (.xiw) is a compiled styling language that transpiles to CSS. It is not syntactic sugar or a wrapper for CSS; it is a structured, typed, and explicit alternative engineered for simplicity and performance.

Architecture

  • Compiler Target: Rust
  • Backends: CSS (Current) | WASM (Future) | JS (Future)

Version

dev-0.1.0

See VERSION for the current release tag.


Principles

Principle Description
Meaningful Every keyword and symbol possesses a single, clearly defined purpose.
Accurate The source code represents the output exactly.
Simple Minimal cognitive load; one way to do one thing.
Performance Build-time compilation producing highly optimized, pure output.

File Format

Files are categorized by their specific architectural role:

  • styles.xiw: Primary style definitions.
  • tokens.xiw: Design tokens and constants.
  • layout.xiw: Structural and grid configurations.

Installation

Prerequisites

Method Requirement
Cargo Rust (latest stable)
Bun Bun v1.2+
Script curl or wget (Unix) / PowerShell (Windows)

Option 1 — Cargo (Rust)

Install from source via crates.io:

cargo install xiwSS

Or build the latest from the repository:

git clone https://github.com/xiw-project/xiwSS.git
cd xiwSS
cargo build --release
./target/release/xiwSS --help

Option 2 — Bun (via npm)

Install globally with Bun (npm registry):

bun install -g @xiw-project/xiwss

Or use the package directly in a project:

bun add -D @xiw-project/xiwss

Option 3 — Installer Script (Universal)

One-liner for Unix (Linux / macOS):

curl -fsSL https://xiw-project.github.io/xiwSS/install.sh | sh

One-liner for Windows (PowerShell):

iex (Invoke-WebRequest -Uri "https://xiw-project.github.io/xiwSS/install.ps1").Content

The installer automatically detects your OS and architecture, downloads the correct pre-built binary from the latest GitHub release, and places it according to the flags below:

Flag Description Default Location
(none) Global system-wide install /usr/local/bin/xiwSS / %ProgramFiles%\xiwSS\xiwSS.exe
--local / -Local Install into local project ./node_modules/.bin/
--dir <path> / -Dir <path> Custom install directory
--dev / -Dev Install latest prerelease/dev build
--version <tag> / -Version <tag> Pin a specific release tag
--force / -Force Reinstall even if up to date

Quick Start

xiw build input.xiw -o output.css
xiw build input.xiw -o output.css --minify
xiw build input.xiw -o output.css --map
xiw watch input.xiw -o output.css
xiw check input.xiw

Package Names

Registry Package
crates.io xiwSS
npm / Bun @xiw-project/xiwss

Licence

Licensed under the Apache 2.0 license.

About

a modern style sheet for modern web.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors