docs: Rename documentation directory from docs to website

Author: unlibra

.github/workflows/deploy-docs.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
     paths:
-      - 'docs/**'
+      - 'website/**'
       - '.github/workflows/deploy-docs.yml'
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -31,20 +31,20 @@ jobs:
         with:
           node-version: 24
           cache: npm
-          cache-dependency-path: docs/package-lock.json
+          cache-dependency-path: website/package-lock.json
 
       - name: Install dependencies
-        working-directory: docs
+        working-directory: website
         run: npm ci
 
       - name: Build website
-        working-directory: docs
+        working-directory: website
         run: npm run build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/build
+          path: website/build
 
   deploy:
     name: Deploy to GitHub Pages

.gitignore

@@ -68,8 +68,10 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
+# Website (Docusaurus)
+website/build/
+website/.docusaurus/
+website/.cache-loader/
 
 # PyBuilder
 target/

website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/docs/api.md

@@ -0,0 +1,91 @@
+---
+sidebar_position: 2
+---
+
+# API Reference
+
+## `Tk` Class
+
+The `Tk` class is a drop-in replacement for `tkinter.Tk` with DPI awareness capabilities.
+
+```python
+from tkinter_unblur import Tk
+```
+
+### Attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `dpi_x` | `int` \| `None` | Horizontal DPI (96 = 100% scaling). `None` on non-Windows platforms. |
+| `dpi_y` | `int` \| `None` | Vertical DPI (96 = 100% scaling). `None` on non-Windows platforms. |
+| `dpi_scaling` | `float` | Scaling factor (1.0 = 100%, 1.5 = 150%, etc.). |
+
+**Example:**
+
+```python
+root = Tk()
+print(f"DPI: {root.dpi_x}x{root.dpi_y}")
+print(f"Scaling: {root.dpi_scaling:.0%}")
+# Output: Scaling: 150%
+```
+
+### Methods
+
+#### `scale_value`
+
+Scale a numeric value according to the current DPI scaling factor.
+
+```python
+def scale_value(self, value: float | str) -> int
+```
+
+**Arguments:**
+- `value`: The value to scale (can be int, float, or numeric string).
+
+**Returns:**
+- The scaled value as an integer.
+
+**Example:**
+
+```python
+from tkinter import Label
+
+root = Tk()
+# Scale font size to maintain physical size across different DPI settings
+label = Label(root, text="Hello", font=("Arial", root.scale_value(12)))
+```
+
+#### `scale_geometry`
+
+Scale a geometry string according to the current DPI scaling factor.
+
+```python
+def scale_geometry(self, geometry: str) -> str
+```
+
+**Arguments:**
+- `geometry`: A Tkinter geometry string in format `"WxH+X+Y"`.
+
+**Returns:**
+- The scaled geometry string.
+
+**Example:**
+
+```python
+root = Tk()
+# Scale window geometry (width x height + x + y)
+root.geometry(root.scale_geometry("800x600+100+50"))
+```
+
+## Exceptions
+
+The library defines the following exceptions in `tkinter_unblur.exceptions`:
+
+### `TkinterUnblurError`
+Base exception for all errors raised by this library.
+
+### `UnsupportedPlatformError`
+Raised when attempting to use Windows-specific features on a non-Windows platform (though the main `Tk` class handles this gracefully by disabling DPI features).
+
+### `DPIDetectionError`
+Raised when DPI detection fails on Windows.

website/docs/index.md

@@ -0,0 +1,82 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+**Fix blurry Tkinter applications on Windows 10/11 high-DPI displays.**
+
+tkinter-unblur provides a drop-in replacement for `tkinter.Tk` that automatically applies DPI awareness on Windows 10/11, fixing the common "blurry text" problem.
+
+## The Problem
+
+Tkinter applications look blurry and pixelated on modern high-resolution displays with scaling enabled (125%, 150%, 200%, etc.). This is because Tkinter is not DPI-aware by default on Windows.
+
+## The Solution
+
+```python
+# Before (blurry)
+from tkinter import Tk
+
+# After (crystal clear)
+from tkinter_unblur import Tk
+```
+
+That's it. One import change, and your Tkinter app renders sharply.
+
+## Installation
+
+```bash
+pip install tkinter-unblur
+```
+
+## Usage
+
+```python
+from tkinter_unblur import Tk
+
+root = Tk()
+root.title("My App")
+root.geometry("800x600")
+root.mainloop()
+```
+
+That's all you need! For advanced usage, see the [API Reference](./api).
+
+## Compatibility
+
+| Platform | Status |
+|----------|--------|
+| Windows 10/11 | Full DPI awareness support |
+| Linux | Passthrough (OS handles DPI) |
+| macOS | Passthrough (OS handles DPI) |
+
+| Python Version | Status |
+|----------------|--------|
+| 3.9 - 3.14 | Supported |
+| 3.8 | Not supported (EOL) |
+
+## Migrating from hdpitkinter
+
+This package was formerly known as `hdpitkinter`. To migrate:
+
+```bash
+pip uninstall hdpitkinter
+pip install tkinter-unblur
+```
+
+```python
+# Old
+from hdpitkinter import HdpiTk
+root = HdpiTk()
+
+# New
+from tkinter_unblur import Tk
+root = Tk()
+```
+
+The `HdpiTk` name is still available as an alias for backwards compatibility:
+
+```python
+from tkinter_unblur import HdpiTk  # Works, but Tk is preferred
+```