fontisan 0.2.14 → 0.2.17

data/docs/cli/variable.md

@@ -0,0 +1,126 @@
+---
+title: variable
+---
+
+# variable
+
+Inspect variable font axes and named instances.
+
+## Quick Reference
+
+```bash
+fontisan variable <font> [options]
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--format FORMAT` | Output format (text, yaml, json) |
+| `--instances` | Show named instances |
+| `--axes` | Show axes only |
+
+## Output
+
+Shows:
+- Variation axes with ranges and defaults
+- Named instances (presets)
+- Axis flags (hidden, etc.)
+
+## Examples
+
+```bash
+# Full variable font info
+fontisan variable VariableFont.ttf
+
+# Show only axes
+fontisan variable VariableFont.ttf --axes
+
+# Show named instances
+fontisan variable VariableFont.ttf --instances
+
+# JSON output for processing
+fontisan variable VariableFont.ttf --format json
+```
+
+## Sample Output
+
+```
+Variable Font: VariableFont.ttf
+================================
+
+Axes (2)
+--------
+Tag     Name          Min      Default  Max      Flags
+------  -----------   -----    -------  -----    -----
+wght    Weight        100      400      900      -
+wdth    Width         75%      100%     125%     -
+
+Named Instances (6)
+-------------------
+Name                  Coordinates
+------------------    --------------------
+Thin                  wght:100
+Light                 wght:300
+Regular               wght:400
+Medium                wght:500
+Bold                  wght:700
+Black                 wght:900
+```
+
+## Understanding Axes
+
+### Standard Axes
+
+| Tag | Name | Typical Range | Description |
+|-----|------|---------------|-------------|
+| `wght` | Weight | 1-999 | Font weight (thin to black) |
+| `wdth` | Width | 50-200 | Width percentage |
+| `slnt` | Slant | -90 to +90 | Slant angle in degrees |
+| `ital` | Italic | 0-1 | Italic toggle |
+| `opsz` | Optical Size | 8-144 | Point size for optical sizing |
+
+### Registered Axes
+
+| Tag | Name | Description |
+|-----|------|-------------|
+| `GRAD` | Grade | Weight change without width change |
+| `XTRA` | X-tra | X-height adjustment |
+| `XOPQ` | X-opaque | Horizontal stroke adjustment |
+| `YOPQ` | Y-opaque | Vertical stroke adjustment |
+| `YTRA` | Y-tra | Y-height adjustment |
+| `YTLC` | Y-lowercase | Lowercase height |
+| `YTUC` | Y-uppercase | Uppercase height |
+| `YTAS` | Y-ascender | Ascender height |
+| `YTDE` | Y-descender | Descender depth |
+| `YTFI` | Y-figure | Figure height |
+
+## Use Cases
+
+### Discover Available Instances
+
+```bash
+fontisan variable font.ttf --instances
+```
+
+### Get Axis Range for Instance Generation
+
+```bash
+# Get weight range
+fontisan variable font.ttf --format json | jq '.axes[] | select(.tag=="wght")'
+```
+
+### Check if Font is Variable
+
+```bash
+if fontisan variable font.ttf 2>/dev/null; then
+  echo "Variable font"
+else
+  echo "Static font"
+fi
+```
+
+## Related Commands
+
+- [instance](/cli/instance) — Generate static instances
+- [info](/cli/info) — Get font information

data/docs/cli/version.md

@@ -0,0 +1,46 @@
+---
+title: version
+---
+
+# version
+
+Display the Fontisan version information.
+
+## Usage
+
+```bash
+fontisan version
+```
+
+## Description
+
+Shows the currently installed version of Fontisan. This is useful for:
+
+- Verifying installation
+- Checking compatibility
+- Reporting issues with version information
+
+## Examples
+
+```bash
+# Show version
+fontisan version
+
+# Output:
+# fontisan 0.1.0
+```
+
+## Programmatic Access
+
+You can also get the version programmatically:
+
+```ruby
+require 'fontisan'
+
+puts Fontisan::VERSION
+```
+
+## Related Commands
+
+- [info](/cli/info) — Get font information
+- [tables](/cli/tables) — List font tables

data/docs/guide/cli/convert.md

@@ -0,0 +1,108 @@
+---
+title: convert
+---
+
+# convert
+
+Convert between font formats.
+
+## Usage
+
+```bash
+fontisan convert INPUT --to FORMAT [options]
+```
+
+## Arguments
+
+| Argument | Description |
+|----------|-------------|
+| `INPUT` | Input font file |
+| `--to FORMAT` | Output format (ttf, otf, woff, woff2) |
+| `--output PATH` | Output file path |
+
+## Options
+
+### Opening Options
+
+| Option | Description |
+|--------|-------------|
+| `--decompose` | Decompose composite glyphs |
+| `--convert-curves` | Convert quadratic ↔ cubic curves |
+| `--scale-to-1000` | Scale to 1000 UPM |
+| `--autohint` | Apply automatic hinting |
+| `--generate-unicode` | Generate Unicode from glyph names |
+| `--preserve-custom-tables` | Preserve non-standard tables |
+
+### Generating Options
+
+| Option | Description |
+|--------|-------------|
+| `--hinting-mode MODE` | preserve, auto, none, full |
+| `--optimize-tables` | Enable table optimization |
+| `--preserve-metadata` | Keep copyright/license info |
+| `--strip-metadata` | Remove metadata |
+| `--target-format FORMAT` | Collection target format |
+
+### Presets
+
+| Option | Description |
+|--------|-------------|
+| `--preset NAME` | Use named preset |
+| `--show-options` | Show recommended options |
+
+## Presets
+
+| Preset | Description |
+|--------|-------------|
+| `type1_to_modern` | Type 1 → OpenType |
+| `modern_to_type1` | OpenType → Type 1 |
+| `web_optimized` | Any → WOFF2 |
+| `archive_to_modern` | Collection → OTF |
+
+## Examples
+
+### Basic Conversion
+
+```bash
+# TTF to OTF
+fontisan convert input.ttf --to otf --output output.otf
+
+# OTF to WOFF2
+fontisan convert input.otf --to woff2 --output output.woff2
+```
+
+### With Options
+
+```bash
+# Convert with autohint
+fontisan convert input.ttf --to otf --autohint --output output.otf
+
+# Convert with curve conversion
+fontisan convert input.ttf --to otf --convert-curves --output output.otf
+```
+
+### Using Presets
+
+```bash
+# Type 1 to modern
+fontisan convert font.pfb --to otf --preset type1_to_modern --output font.otf
+
+# Web optimized
+fontisan convert font.otf --to woff2 --preset web_optimized --output font.woff2
+```
+
+### Show Options
+
+```bash
+# See what options will be used
+fontisan convert input.ttf --to otf --show-options
+```
+
+## Batch Conversion
+
+```bash
+# Convert all TTF files
+for f in *.ttf; do
+  fontisan convert "$f" --to woff2 --output "${f%.ttf}.woff2"
+done
+```

data/docs/guide/cli/export.md

@@ -0,0 +1,138 @@
+---
+title: export
+---
+
+# export
+
+Export font data to various formats.
+
+## Usage
+
+```bash
+fontisan export FONT [options]
+```
+
+## Arguments
+
+| Argument | Description |
+|----------|-------------|
+| `FONT` | Input font file |
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--format FORMAT` | Export format (ttx, svg, ufo) |
+| `--output PATH` | Output file/directory |
+| `--tables LIST` | Export specific tables |
+
+## Export Formats
+
+| Format | Description |
+|--------|-------------|
+| `ttx` | XML dump of font tables |
+| `svg` | SVG font format |
+| `ufo` | Unified Font Object |
+
+## Examples
+
+### Export to TTX
+
+```bash
+# Export all tables
+fontisan export font.ttf --format ttx --output font.ttx
+
+# Export specific tables
+fontisan export font.ttf --format ttx --tables head,name,cmap --output font-partial.ttx
+```
+
+### Export to SVG
+
+```bash
+# Create SVG font
+fontisan export font.ttf --format svg --output font.svg
+```
+
+### Export to UFO
+
+```bash
+# Create UFO package
+fontisan export font.ttf --format ufo --output font.ufo
+```
+
+## TTX Format
+
+TTX is an XML representation of font tables:
+
+```xml
+<?xml version="1.0"?>
+<ttFont>
+  <head>
+    <tableVersion value="1.0"/>
+    <fontRevision value="1.0"/>
+    <unitsPerEm value="1000"/>
+    ...
+  </head>
+  <name>
+    <namerecord nameID="1">Example</namerecord>
+    ...
+  </name>
+</ttFont>
+```
+
+### Export Specific Tables
+
+```bash
+# Just head and name
+fontisan export font.ttf --format ttx --tables head,name --output tables.ttx
+```
+
+### Compare Tables
+
+```bash
+# Export from two fonts
+fontisan export font1.ttf --format ttx --tables name --output name1.ttx
+fontisan export font2.ttf --format ttx --tables name --output name2.ttx
+
+# Compare
+diff name1.ttx name2.ttx
+```
+
+## SVG Export
+
+Creates an SVG font file:
+
+```bash
+fontisan export font.ttf --format svg --output font.svg
+```
+
+Result:
+```xml
+<svg xmlns="http://www.w3.org/2000/svg">
+  <font>
+    <font-face font-family="Example"/>
+    <glyph unicode="A" d="M0 0 L100 0..."/>
+    <glyph unicode="B" d="M0 0 L100 0..."/>
+  </font>
+</svg>
+```
+
+## UFO Export
+
+Creates a UFO (Unified Font Object) package:
+
+```bash
+fontisan export font.ttf --format ufo --output font.ufo
+```
+
+Structure:
+```
+font.ufo/
+├── fontinfo.plist
+├── glyphs/
+│   ├── A.glif
+│   ├── B.glif
+│   └── ...
+├── glyphs.contents
+└── metainfo.plist
+```

data/docs/guide/cli/index.md

@@ -0,0 +1,99 @@
+---
+title: CLI Overview
+---
+
+# CLI Overview
+
+Fontisan includes a comprehensive command-line interface.
+
+## Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `convert` | Convert between font formats |
+| `info` | Get font information |
+| `validate` | Validate fonts |
+| `subset` | Subset fonts |
+| `pack` | Create font collections |
+| `unpack` | Extract from collections |
+| `export` | Export to TTX, SVG, etc. |
+| `ls` | List fonts in collection |
+| `instance` | Generate variable font instances |
+
+## Global Options
+
+```bash
+fontisan [options] <command>
+
+Options:
+  --format FORMAT    Output format (text, yaml, json)
+  --verbose          Verbose output
+  --quiet            Suppress non-error output
+  --help             Show help
+  --version          Show version
+```
+
+## Getting Help
+
+```bash
+# General help
+fontisan --help
+
+# Command help
+fontisan convert --help
+fontisan validate --help
+```
+
+## Output Formats
+
+### Text (default)
+
+```bash
+fontisan info font.ttf
+```
+
+### YAML
+
+```bash
+fontisan info font.ttf --format yaml
+```
+
+### JSON
+
+```bash
+fontisan info font.ttf --format json
+```
+
+## Guides
+
+- [convert](/guide/cli/convert) — Format conversion
+- [info](/guide/cli/info) — Font information
+- [validate](/guide/cli/validate) — Validation
+- [subset](/guide/cli/subset) — Subsetting
+- [pack](/guide/cli/pack) — Collections
+
+## Examples
+
+### Basic Conversion
+
+```bash
+fontisan convert input.ttf --to otf --output output.otf
+```
+
+### Validate for Web
+
+```bash
+fontisan validate font.ttf --profile web
+```
+
+### Extract Collection
+
+```bash
+fontisan unpack fonts.ttc --output-dir ./extracted
+```
+
+### Generate Instance
+
+```bash
+fontisan instance variable.ttf --wght 700 --output bold.ttf
+```

data/docs/guide/cli/info.md

@@ -0,0 +1,144 @@
+---
+title: info
+---
+
+# info
+
+Get font information.
+
+## Usage
+
+```bash
+fontisan info FONT [options]
+```
+
+## Arguments
+
+| Argument | Description |
+|----------|-------------|
+| `FONT` | Font file to analyze |
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--format FORMAT` | Output format (text, yaml, json) |
+| `--tables` | Show table information |
+| `--glyphs` | Show glyph information |
+| `--unicode` | Show Unicode coverage |
+| `--features` | Show OpenType features |
+| `--verbose` | Detailed output |
+
+## Examples
+
+### Basic Info
+
+```bash
+fontisan info font.ttf
+
+# Font: font.ttf
+# Format: TrueType
+# Family: Example
+# Style: Regular
+# Version: 1.000
+# Glyphs: 268
+# Tables: 14
+```
+
+### Table Information
+
+```bash
+fontisan info font.ttf --tables
+
+# Tables:
+#   head - Font header (54 bytes)
+#   hhea - Horizontal header (36 bytes)
+#   maxp - Maximum profile (32 bytes)
+#   name - Naming table (2456 bytes)
+#   cmap - Character mapping (1234 bytes)
+#   ...
+```
+
+### Unicode Coverage
+
+```bash
+fontisan info font.ttf --unicode
+
+# Unicode Coverage:
+#   Basic Latin (U+0000-U+007F)
+#   Latin-1 Supplement (U+0080-U+00FF)
+#   Latin Extended-A (U+0100-U+017F)
+#   ...
+```
+
+### OpenType Features
+
+```bash
+fontisan info font.ttf --features
+
+# OpenType Features:
+#   GSUB:
+#     liga - Ligatures
+#     kern - Kerning
+#   GPOS:
+#     kern - Kerning
+#     mark - Mark positioning
+```
+
+### YAML Output
+
+```bash
+fontisan info font.ttf --format yaml
+
+# family: Example
+# style: Regular
+# version: 1.000
+# glyphs: 268
+# tables:
+#   head: 54
+#   hhea: 36
+#   ...
+```
+
+### JSON Output
+
+```bash
+fontisan info font.ttf --format json
+
+# {
+#   "family": "Example",
+#   "style": "Regular",
+#   "version": "1.000",
+#   "glyphs": 268
+# }
+```
+
+## Variable Font Info
+
+```bash
+fontisan info variable.ttf
+
+# Variable Font Axes: 2
+#   wght (Weight): 100 - 900, default: 400
+#   wdth (Width): 75 - 125, default: 100
+#
+# Named Instances: 6
+#   0: Thin (wght=100)
+#   1: Light (wght=300)
+#   2: Regular (wght=400)
+#   ...
+```
+
+## Collection Info
+
+```bash
+fontisan info fonts.ttc
+
+# Collection: fonts.ttc
+# Format: TTC
+# Fonts: 4
+# Size: 256 KB
+#
+# Shared Tables: 4
+# Space Saved: 45%
+```