fontisan 0.2.13 → 0.2.16

data/docs/.vitepress/config.ts

@@ -0,0 +1,317 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: "en-US",
+
+  // https://vitepress.dev/guide/routing#generating-clean-url
+  cleanUrls: true,
+
+  title: "Fontisan",
+  description:
+    "The most comprehensive font processing library for Ruby — 100% Pure Ruby, no Python, no C++, no C# dependencies.",
+
+  lastUpdated: true,
+
+  // Base path for deployment (e.g., /fontisan/ for fontist.org/fontisan/)
+  base: process.env.BASE_PATH || "/fontisan/",
+
+  head: [
+    [
+      "link",
+      { rel: "icon", type: "image/png", href: "/favicon-96x96.png", sizes: "96x96" },
+    ],
+    ["link", { rel: "icon", type: "image/svg+xml", href: "/favicon.svg" }],
+    ["link", { rel: "shortcut icon", href: "/favicon.ico" }],
+    [
+      "link",
+      { rel: "apple-touch-icon", sizes: "180x180", href: "/apple-touch-icon.png" },
+    ],
+    ["link", { rel: "manifest", href: "/site.webmanifest" }],
+    ["meta", { property: "og:type", content: "website" }],
+    ["meta", { property: "og:title", content: "Fontisan" }],
+    [
+      "meta",
+      {
+        property: "og:description",
+        content:
+          "The most comprehensive font processing library for Ruby — 100% Pure Ruby.",
+      },
+    ],
+    ["meta", { property: "og:image", content: "/logo-full.svg" }],
+    ["meta", { name: "twitter:card", content: "summary_large_image" }],
+  ],
+
+  // https://vitepress.dev/reference/default-theme-config
+  themeConfig: {
+    logo: "/logo-full.svg",
+    siteTitle: false,
+
+    // Local search with MiniSearch
+    search: {
+      provider: "local",
+      options: {
+        detailedView: true,
+        miniSearch: {
+          searchOptions: {
+            fuzzy: 0.2,
+            prefix: true,
+            boost: { title: 4, text: 2, titles: 1 },
+          },
+        },
+      },
+    },
+
+    // Top navigation (minimal: 4 items)
+    nav: [
+      { text: "← Fontist.org", link: "https://www.fontist.org" },
+      { text: "Guide", link: "/guide/" },
+      { text: "CLI", link: "/cli/" },
+      { text: "API", link: "/api/" },
+      { text: "Fontist", link: "https://www.fontist.org/fontist/", target: "_self" },
+      { text: "Formulas", link: "https://www.fontist.org/formulas/", target: "_self" },
+    ],
+
+    // Sidebar configuration
+    sidebar: {
+      "/guide/": [
+        {
+          text: "Getting Started",
+          items: [
+            { text: "Introduction", link: "/guide/" },
+            { text: "Installation", link: "/guide/installation" },
+            { text: "Quick Start", link: "/guide/quick-start" },
+          ],
+        },
+        {
+          text: "CLI Reference",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/cli/" },
+            { text: "convert", link: "/guide/cli/convert" },
+            { text: "info", link: "/guide/cli/info" },
+            { text: "validate", link: "/guide/cli/validate" },
+            { text: "subset", link: "/guide/cli/subset" },
+            { text: "pack/unpack", link: "/guide/cli/pack" },
+            { text: "export", link: "/guide/cli/export" },
+          ],
+        },
+        {
+          text: "Font Formats",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/formats/" },
+            { text: "TrueType (TTF)", link: "/guide/formats/ttf" },
+            { text: "OpenType (OTF)", link: "/guide/formats/otf" },
+            { text: "Type 1 (PFB/PFA)", link: "/guide/formats/type1" },
+            { text: "WOFF & WOFF2", link: "/guide/formats/woff" },
+            { text: "Collections (TTC/OTC)", link: "/guide/formats/collections" },
+            { text: "Apple dfont", link: "/guide/formats/dfont" },
+            { text: "SVG Fonts", link: "/guide/formats/svg" },
+          ],
+        },
+        {
+          text: "Conversion Guide",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/conversion/" },
+            { text: "TTF ↔ OTF", link: "/guide/conversion/ttf-otf" },
+            { text: "Type 1 → Modern", link: "/guide/conversion/type1" },
+            { text: "Web Formats", link: "/guide/conversion/web" },
+            { text: "Collections", link: "/guide/conversion/collections" },
+            { text: "Curve Conversion", link: "/guide/conversion/curves" },
+            { text: "Options Reference", link: "/guide/conversion/options" },
+          ],
+        },
+        {
+          text: "Validation",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/validation/" },
+            { text: "Validation Profiles", link: "/guide/validation/profiles" },
+            { text: "Validation Helpers", link: "/guide/validation/helpers" },
+            { text: "Custom Validators", link: "/guide/validation/custom" },
+          ],
+        },
+        {
+          text: "Variable Fonts",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/variable-fonts/" },
+            { text: "Axes & Instances", link: "/guide/variable-fonts/axes" },
+            { text: "Instance Generation", link: "/guide/variable-fonts/instances" },
+            { text: "Format Conversion", link: "/guide/variable-fonts/conversion" },
+            { text: "Named Instances", link: "/guide/variable-fonts/named-instances" },
+            { text: "Static Fonts", link: "/guide/variable-fonts/static" },
+            { text: "Advanced Topics", link: "/guide/variable-fonts/advanced" },
+          ],
+        },
+        {
+          text: "Font Hinting",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/hinting/" },
+            { text: "TrueType Hinting", link: "/guide/hinting/truetype" },
+            { text: "PostScript Hinting", link: "/guide/hinting/postscript" },
+            { text: "Hint Conversion", link: "/guide/hinting/conversion" },
+            { text: "Autohint", link: "/guide/hinting/autohint" },
+          ],
+        },
+        {
+          text: "Color Fonts",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/color-fonts/" },
+            { text: "COLR/CPAL", link: "/guide/color-fonts/colr-cpal" },
+            { text: "sbix & CBDT", link: "/guide/color-fonts/bitmaps" },
+            { text: "SVG Color", link: "/guide/color-fonts/svg" },
+          ],
+        },
+        {
+          text: "Migration Guides",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/migrations/" },
+            { text: "From fonttools (Python)", link: "/guide/migrations/fonttools" },
+            { text: "From extract_ttc", link: "/guide/migrations/extract-ttc" },
+            { text: "From otfinfo", link: "/guide/migrations/otfinfo" },
+            { text: "From Font-Validator", link: "/guide/migrations/font-validator" },
+          ],
+        },
+        {
+          text: "Feature Comparisons",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/comparisons/" },
+            { text: "vs fonttools", link: "/guide/comparisons/fonttools" },
+            { text: "vs lcdf-typetools", link: "/guide/comparisons/lcdf-typetools" },
+            { text: "vs Font-Validator", link: "/guide/comparisons/font-validator" },
+          ],
+        },
+        {
+          text: "Advanced Topics",
+          collapsed: true,
+          items: [
+            { text: "Universal Outline Model", link: "/guide/universal-outline" },
+          ],
+        },
+        {
+          text: "Contributing",
+          collapsed: true,
+          items: [
+            { text: "Contributing Guide", link: "/guide/contributing" },
+          ],
+        },
+      ],
+      "/cli/": [
+        {
+          text: "CLI Reference",
+          items: [
+            { text: "Overview", link: "/cli/" },
+          ],
+        },
+        {
+          text: "Font Information",
+          collapsed: true,
+          items: [
+            { text: "info", link: "/cli/info" },
+            { text: "ls", link: "/cli/ls" },
+            { text: "tables", link: "/cli/tables" },
+            { text: "glyphs", link: "/cli/glyphs" },
+            { text: "unicode", link: "/cli/unicode" },
+            { text: "scripts", link: "/cli/scripts" },
+            { text: "features", link: "/cli/features" },
+            { text: "variable", link: "/cli/variable" },
+            { text: "optical-size", link: "/cli/optical-size" },
+          ],
+        },
+        {
+          text: "Font Operations",
+          collapsed: true,
+          items: [
+            { text: "convert", link: "/cli/convert" },
+            { text: "subset", link: "/cli/subset" },
+            { text: "validate", link: "/cli/validate" },
+            { text: "instance", link: "/cli/instance" },
+            { text: "export", link: "/cli/export" },
+            { text: "dump-table", link: "/cli/dump-table" },
+          ],
+        },
+        {
+          text: "Collection Operations",
+          collapsed: true,
+          items: [
+            { text: "pack/unpack", link: "/cli/pack" },
+          ],
+        },
+        {
+          text: "Utilities",
+          collapsed: true,
+          items: [
+            { text: "version", link: "/cli/version" },
+          ],
+        },
+      ],
+      "/api/": [
+        {
+          text: "API Reference",
+          items: [
+            { text: "Overview", link: "/api/" },
+          ],
+        },
+        {
+          text: "Core Classes",
+          collapsed: true,
+          items: [
+            { text: "FontLoader", link: "/api/font-loader" },
+            { text: "FontWriter", link: "/api/font-writer" },
+            { text: "ConversionOptions", link: "/api/conversion-options" },
+            { text: "SfntFont", link: "/api/sfnt-font" },
+            { text: "Type1Font", link: "/api/type1-font" },
+          ],
+        },
+        {
+          text: "Converters",
+          collapsed: true,
+          items: [
+            { text: "OutlineConverter", link: "/api/converters/outline-converter" },
+            { text: "CurveConverter", link: "/api/converters/curve-converter" },
+            { text: "HintConverter", link: "/api/converters/hint-converter" },
+          ],
+        },
+        {
+          text: "Validators",
+          collapsed: true,
+          items: [
+            { text: "FontValidator", link: "/api/validators/font-validator" },
+            { text: "ValidationProfile", link: "/api/validators/profile" },
+            { text: "ValidationHelper", link: "/api/validators/helper" },
+          ],
+        },
+        {
+          text: "Models",
+          collapsed: true,
+          items: [
+            { text: "Glyph", link: "/api/models/glyph" },
+            { text: "GlyphAccessor", link: "/api/models/glyph-accessor" },
+            { text: "TableAnalyzer", link: "/api/models/table-analyzer" },
+          ],
+        },
+      ],
+    },
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/fontist/fontisan" },
+    ],
+
+    footer: {
+      message: 'Fontisan is a [Ribose](https://open.ribose.com/) project',
+      copyright: `Copyright © 2026 Ribose Group Inc. All rights reserved.`,
+    },
+
+    editLink: {
+      pattern: "https://github.com/fontist/fontisan/edit/main/docs/:path",
+      text: "Edit this page on GitHub",
+    },
+  },
+});

data/docs/.vitepress/theme/components/ApiMethod.vue

@@ -0,0 +1,127 @@
+<template>
+  <div class="api-method">
+    <div class="method-header">
+      <code class="method-signature">
+        <span class="method-name">{{ name }}</span
+        ><span class="method-params"
+          >({{ params.map((p) => p.name).join(", ") }})</span
+        >
+      </code>
+      <span v-if="returns" class="method-returns"> → {{ returns }}</span>
+    </div>
+    <p v-if="description" class="method-description">{{ description }}</p>
+    <div v-if="params.length" class="method-params-list">
+      <h4>Parameters</h4>
+      <ul>
+        <li v-for="param in params" :key="param.name">
+          <code>{{ param.name }}</code>
+          <span v-if="param.type" class="param-type">: {{ param.type }}</span>
+          <span v-if="param.required" class="param-required">*</span>
+          <span v-if="param.description" class="param-desc"
+            >— {{ param.description }}</span
+          >
+        </li>
+      </ul>
+    </div>
+    <div v-if="example" class="method-example">
+      <h4>Example</h4>
+      <pre><code :class="`language-${exampleLang}`">{{ example }}</code></pre>
+    </div>
+  </div>
+</template>
+
+<script setup lang="ts">
+interface Param {
+  name: string;
+  type?: string;
+  required?: boolean;
+  description?: string;
+}
+
+defineProps<{
+  name: string;
+  params?: Param[];
+  returns?: string;
+  description?: string;
+  example?: string;
+  exampleLang?: string;
+}>();
+</script>
+
+<style scoped>
+.api-method {
+  margin: 1.5rem 0;
+  padding: 1rem;
+  border: 1px solid var(--vp-c-divider);
+  border-radius: 8px;
+  background: var(--vp-c-bg-soft);
+}
+
+.method-header {
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+  flex-wrap: wrap;
+}
+
+.method-signature {
+  font-size: 1rem;
+  font-weight: 500;
+}
+
+.method-name {
+  color: var(--vp-c-brand-1);
+}
+
+.method-params {
+  color: var(--vp-c-text-2);
+}
+
+.method-returns {
+  color: var(--vp-c-text-2);
+  font-size: 0.9rem;
+}
+
+.method-description {
+  margin: 0.75rem 0 0;
+  color: var(--vp-c-text-2);
+}
+
+.method-params-list h4,
+.method-example h4 {
+  margin: 1rem 0 0.5rem;
+  font-size: 0.85rem;
+  font-weight: 600;
+  color: var(--vp-c-text-1);
+}
+
+.method-params-list ul {
+  margin: 0;
+  padding-left: 1.5rem;
+  list-style: disc;
+}
+
+.method-params-list li {
+  margin: 0.25rem 0;
+}
+
+.param-type {
+  color: var(--vp-c-text-3);
+}
+
+.param-required {
+  color: var(--vp-c-danger-1);
+}
+
+.param-desc {
+  color: var(--vp-c-text-2);
+}
+
+.method-example pre {
+  margin: 0.5rem 0;
+  padding: 1rem;
+  background: var(--vp-c-bg-alt);
+  border-radius: 6px;
+  overflow-x: auto;
+}
+</style>

data/docs/.vitepress/theme/components/Badge.vue

@@ -0,0 +1,51 @@
+<template>
+  <span :class="['badge', type]">
+    <slot />
+  </span>
+</template>
+
+<script setup lang="ts">
+defineProps<{
+  type?: "tip" | "warning" | "danger" | "info" | "pure-ruby";
+}>();
+</script>
+
+<style scoped>
+.badge {
+  display: inline-flex;
+  align-items: center;
+  padding: 0.125rem 0.5rem;
+  border-radius: 9999px;
+  font-size: 0.75rem;
+  font-weight: 600;
+  line-height: 1.25rem;
+}
+
+.tip {
+  background-color: var(--vp-c-brand-soft);
+  color: var(--vp-c-brand-1);
+}
+
+.warning {
+  background-color: rgba(255, 197, 61, 0.14);
+  color: var(--vp-c-warning-1);
+}
+
+.danger {
+  background-color: rgba(244, 63, 94, 0.14);
+  color: var(--vp-c-danger-1);
+}
+
+.info {
+  background-color: rgba(96, 165, 250, 0.14);
+  color: var(--vp-c-info-1);
+}
+
+.pure-ruby {
+  background: linear-gradient(135deg, var(--fontist-rose), #d4718a);
+  color: white;
+  font-weight: 700;
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+}
+</style>

data/docs/.vitepress/theme/components/FeatureComparison.vue

@@ -0,0 +1,87 @@
+<template>
+  <table class="feature-comparison">
+    <thead>
+      <tr>
+        <th>Feature</th>
+        <th v-for="tool in tools" :key="tool">{{ tool }}</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr v-for="feature in features" :key="feature.name">
+        <td class="feature-name">{{ feature.name }}</td>
+        <td
+          v-for="(tool, index) in tools"
+          :key="tool"
+          :class="getSupportClass(feature.support[index])"
+        >
+          <span class="support-icon">{{ getSupportIcon(feature.support[index]) }}</span>
+          <span v-if="feature.notes?.[index]" class="note">{{ feature.notes[index] }}</span>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</template>
+
+<script setup lang="ts">
+interface Feature {
+  name: string;
+  support: boolean[];
+  notes?: string[];
+}
+
+defineProps<{
+  tools: string[];
+  features: Feature[];
+}>();
+
+function getSupportIcon(supported: boolean): string {
+  return supported ? "✓" : "✗";
+}
+
+function getSupportClass(supported: boolean): string {
+  return supported ? "supported" : "not-supported";
+}
+</script>
+
+<style scoped>
+.feature-comparison {
+  width: 100%;
+  border-collapse: collapse;
+  margin: 1rem 0;
+}
+
+.feature-comparison th,
+.feature-comparison td {
+  padding: 0.75rem 1rem;
+  text-align: left;
+  border-bottom: 1px solid var(--vp-c-divider);
+}
+
+.feature-comparison th {
+  background: var(--vp-c-bg-soft);
+  font-weight: 600;
+}
+
+.feature-name {
+  font-weight: 500;
+}
+
+.supported {
+  color: var(--vp-c-green-1);
+}
+
+.not-supported {
+  color: var(--vp-c-red-1);
+}
+
+.support-icon {
+  font-weight: bold;
+}
+
+.note {
+  display: block;
+  font-size: 0.85rem;
+  color: var(--vp-c-text-2);
+  margin-top: 0.25rem;
+}
+</style>

data/docs/.vitepress/theme/components/HeroCodeBlock.vue

@@ -0,0 +1,98 @@
+<script setup>
+defineProps({
+  title: {
+    type: String,
+    default: 'Terminal'
+  }
+})
+</script>
+
+<template>
+  <div class="hero-code-block">
+    <div class="code-header">
+      <span class="dot"></span>
+      <span class="dot"></span>
+      <span class="dot"></span>
+      <span class="code-title">{{ title }}</span>
+    </div>
+    <div class="code-content"><slot /></div>
+  </div>
+</template>
+
+<style scoped>
+.hero-code-block {
+  background: var(--vp-c-bg-soft);
+  border: 1px solid var(--vp-c-divider);
+  border-radius: 12px;
+  overflow: hidden;
+  box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
+  max-width: 550px;
+  width: 100%;
+  font-size: 0.85rem;
+}
+
+@media (max-width: 768px) {
+  .hero-code-block {
+    max-width: 100%;
+    font-size: 0.8rem;
+  }
+}
+
+.code-header {
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+  padding: 0.75rem 1rem;
+  background: var(--vp-c-bg-alt);
+  border-bottom: 1px solid var(--vp-c-divider);
+}
+
+.dot {
+  width: 12px;
+  height: 12px;
+  border-radius: 50%;
+  flex-shrink: 0;
+}
+
+.dot:nth-child(1) { background: #ff5f56; }
+.dot:nth-child(2) { background: #ffbd2e; }
+.dot:nth-child(3) { background: #28c840; }
+
+.code-title {
+  margin-left: auto;
+  font-size: 0.8rem;
+  color: var(--vp-c-text-3);
+}
+
+.code-content {
+  margin: 0;
+  padding: 1.25rem;
+  font-family: var(--vp-font-family-mono);
+  font-size: inherit;
+  line-height: 1.7;
+  overflow-x: auto;
+  -webkit-overflow-scrolling: touch;
+}
+
+.code-content :deep(.line) {
+  display: block;
+}
+
+.code-content :deep(.prompt) {
+  color: var(--vp-c-brand-1);
+  font-weight: 500;
+}
+
+.code-content :deep(.success) {
+  color: #28c840;
+}
+
+.code-content :deep(.comment) {
+  color: var(--vp-c-text-3);
+  font-style: italic;
+}
+
+.code-content :deep(.cmd) {
+  font-weight: 600;
+}
+</style>