-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Wisp documentation! This wiki contains comprehensive guides for using, developing, and contributing to Wisp.
| Page | Description |
|---|---|
| Installation | Setup instructions for macOS, Linux, and Windows |
| Usage Guide | CLI commands and Python API examples |
| Architecture | Technical design and system overview |
| API Reference | Complete API documentation |
| Context Types | Understanding narrative, dashboard, form, and minimal contexts |
| Contributing | How to contribute to the project |
| Troubleshooting | Common issues and solutions |
Wisp is a context-aware, zero-dependency UI engine that analyzes your HTML structure and automatically generates optimized CSS. Unlike traditional frameworks that require you to add classes or configure themes, Wisp examines your content and adapts the styling accordingly.
- Zero Configuration: Works out of the box with semantic HTML
- Context-Aware: Automatically detects content type (narrative, dashboard, form, minimal)
- Lightweight: <5KB total payload (2KB CSS + 2KB JS)
- Zero Dependencies: No build tools, no npm, no bundlers required
- Accessibility First: Auto-generates skip links and respects user preferences
# Clone and setup
git clone https://github.com/rotsl/wisp.git
cd wisp
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
# Analyze a webpage
./wisp-fetch https://en.wikipedia.org/wiki/Wiki --open- GitHub Pages: https://rotsl.github.io/wisp/
- GitLab Pages: https://wisp-d69513.gitlab.io/
We welcome contributions! See Contributing for guidelines.
MIT License - see LICENSE file.
---
### **Installation.md** (GitHub Wiki)
```markdown
# Installation Guide
This guide covers installing Wisp on different operating systems.
## 📋 Prerequisites
- Python 3.8 or higher
- Git
- (Optional) Node.js if you want to modify the JavaScript runtime
## 🍎 macOS Installation
### Step 1: Clone Repository
```bash
git clone https://github.com/rotsl/wisp.git
cd wisp
python3 -m venv venv
source venv/bin/activatepip install -r requirements.txtpython scripts/build.py
python tests/test_scanner.pysudo ln -s $(pwd)/wisp-fetch /usr/local/bin/wisp-fetch# Install Python and pip
sudo apt update
sudo apt install python3 python3-pip python3-venv git
# Clone and setup
git clone https://github.com/rotsl/wisp.git
cd wisp
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txtsudo dnf install python3 python3-pip git
# Follow same steps as Ubuntugit clone https://github.com/rotsl/wisp.git
cd wisp
python -m venv venv
venv\Scripts\activate
pip install -r requirements.txtgit clone https://github.com/rotsl/wisp.git
cd wisp
python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r requirements.txtRun the test suite to ensure everything works:
python tests/test_scanner.pyExpected output:
Running Wisp Scanner tests...
✓ Narrative detection
✓ Dashboard detection
✓ Form detection
✓ CSS generation
✓ Density calculation
✅ All tests passed!
To update to the latest version:
cd ~/wisp
git pull origin main
source venv/bin/activate
pip install -r requirements.txt --upgradeSimply delete the directory:
rm -rf ~/wisp
# If you created a symlink:
sudo rm /usr/local/bin/wisp-fetchSolution: Use python3 instead of python on macOS/Linux
Solution: Ensure virtual environment is activated (you should see (venv) in prompt)
Solution: Use ./wisp-fetch from the wisp directory, or use the full path
Core dependencies (automatically installed):
- beautifulsoup4>=4.12.0
- lxml>=4.9.0
- requests>=2.31.0
Optional (for minification):
- jsmin>=3.0.0
- rcssmin>=1.1.0