fontist 2.1.3 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b50fa7f2d919278a80d47cc5c35942960903a5ed586fc37c0cf21b944a76df1e
-  data.tar.gz: cc98d5a18b0e00e62a8ca5f41bd54645e3cf2e92f600d4a91c7ceb79c3110bf5
+  metadata.gz: 0625c7b3933a74de8462f617558b73b8c4a27112e42a4066209dd66f805df21d
+  data.tar.gz: 7fb21a4892763ed22113cec7950af17a6c716d00f3dc8b569a636c3de013a594
 SHA512:
-  metadata.gz: a641b85c69158cbc1430407d0c72c5a480f96b6e77a500834691a579591d1d448c522fa65307c28597b5082bec3a4a6d83913a09dc7066eb533732b9f7dfa8fe
-  data.tar.gz: ac31ba8b42034ec098178b6db77f3d35325d81455b0c98d979ec98975ed2d93cf80a40dbb6e7f3f721e8ddd9925ca4ed9b2c9088b06eb88cb27585687ff06dc8
+  metadata.gz: 8446fbdb79e95e818298e6ed0f487789299992afc598676f5bd7f376e8c3dbedc267d46ffcf9acf6cf67c5bb66d96d34338677ce7f9818d0c167729e6db1770e
+  data.tar.gz: 9ca12d1d2a163a289fe0ed5cef1bee92f0f5d6e48b3b79c30c9a9eb86da189802fce19c66393736038d925822524357066d91bed1c54699509a5b26b119cac11

data/.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: docs
+
+      - name: Build
+        run: npm run build
+        working-directory: docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: github.ref_name == github.event.repository.default_branch
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

data/.github/workflows/links.yml

@@ -0,0 +1,100 @@
+name: Link Checker
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    paths:
+      - 'docs/**'
+  schedule:
+    # Run weekly on Sunday at 00:00 UTC
+    - cron: '0 0 * * 0'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  link_checker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: docs
+
+      - name: Build
+        run: npm run build
+        working-directory: docs
+
+      - name: Restore lychee cache
+        uses: actions/cache@v4
+        with:
+          path: .lycheecache
+          key: cache-lychee-${{ github.sha }}
+          restore-keys: cache-lychee-
+
+      - name: Check if site was built
+        run: |
+          if [ ! -d "dist" ]; then
+            echo "Error: dist directory not created"
+            exit 1
+          fi
+          echo "Site built successfully"
+          ls -la dist/
+        working-directory: docs/.vitepress
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: >-
+            --verbose
+            --no-progress
+            --config lychee.toml
+            --root-dir "$(pwd)/.vitepress/dist"
+            --base-url file://${{ github.workspace }}/docs/.vitepress/dist
+            '.vitepress/dist/**/*.html'
+          fail: true
+          output: link-check-results.md
+          format: markdown
+          workingDirectory: docs
+
+      - name: Upload link check results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: link-check-results
+          path: link-check-results.md
+          retention-days: 30
+
+      - name: Comment PR with results
+        if: failure() && github.event_name == 'pull_request'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            let comment = '## 🔗 Link Check Failed\n\n';
+
+            if (fs.existsSync('link-check-results.md')) {
+              const results = fs.readFileSync('link-check-results.md', 'utf8');
+              comment += '### Results\n\n' + results + '\n\n';
+            }
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment
+            });

data/.gitignore

@@ -28,7 +28,9 @@ Gemfile.lock
 .kilocode
 .claude
 old-docs/
-.md
+CLAUDE.md
 
 # macOS font catalogs (downloaded via rake task)
 /spec/fixtures/macos_catalogs/com_apple_MobileAsset_Font*.xml
+
+.lycheecache

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 gem "bundler"
 gem "openssl", "~> 3.0"
+gem "ostruct"
 gem "pry"
 gem "rake"
 gem "rspec"

data/docs/.vitepress/config.ts

@@ -1,7 +1,18 @@
 import { defineConfig } from "vitepress";
+import { fileURLToPath, URL } from "node:url";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
+  // Register custom components
+  vite: {
+    resolve: {
+      alias: {
+        "@components": fileURLToPath(new URL("../components", import.meta.url)),
+      },
+    },
+  },
+  lang: "en-US",
+
   // https://vitepress.dev/guide/routing#generating-clean-url
   cleanUrls: true,
 
@@ -9,63 +20,190 @@ export default defineConfig({
   description:
     "Fontist brings cross-platform font management to the command line for Windows, Linux, and macOS. Free and open source.",
 
-  // https://github.com/vuejs/vitepress/issues/3508
-  base: process.env.BASE_PATH,
+  lastUpdated: true,
+
+  // Base path for deployment (e.g., /fontist/ for fontist.org/fontist/)
+  base: process.env.BASE_PATH || "/fontist/",
+
+  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: "Fontist" }],
+    [
+      "meta",
+      {
+        property: "og:description",
+        content:
+          "Fontist brings cross-platform font management to the command line for Windows, Linux, and macOS.",
+      },
+    ],
+    ["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.png",
+    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 },
+          },
+        },
+      },
+    },
 
     nav: [
-      { text: "Home", link: "/" },
+      { text: "← Fontist.org", link: "https://www.fontist.org" },
       { text: "Guide", link: "/guide/" },
-      { text: "Reference", link: "/reference/" },
-      {
-        text: "Formulas",
-        link: "https://fontist.org/formulas/",
-        target: "_self",
-      },
+      { text: "CLI", link: "/cli/" },
+      { text: "API", link: "/api/" },
+      { text: "Formulas", link: "https://www.fontist.org/formulas/", target: "_self" },
+      { text: "Fontisan", link: "https://www.fontist.org/fontisan/", target: "_self" },
     ],
 
     sidebar: {
       "/guide/": [
         {
-          text: "Guide",
+          text: "Getting Started",
+          items: [
+            { text: "Introduction", link: "/guide/" },
+            { text: "Installation", link: "/guide/installation" },
+            { text: "Quick Start", link: "/guide/quick-start" },
+          ],
+        },
+        {
+          text: "Concepts",
+          items: [
+            { text: "Overview", link: "/guide/concepts/" },
+            { text: "Fonts & Styles", link: "/guide/concepts/fonts" },
+            { text: "Variable Fonts", link: "/guide/concepts/variable-fonts" },
+            { text: "Formats & Containers", link: "/guide/concepts/formats" },
+            { text: "Licenses", link: "/guide/concepts/licenses" },
+            { text: "Requirements", link: "/guide/concepts/requirements" },
+          ],
+        },
+        {
+          text: "Learn More",
+          collapsed: true,
           items: [
+            { text: "How Fontist Works", link: "/guide/how-it-works" },
             { text: "Why Fontist?", link: "/guide/why" },
-            { text: "Getting started", link: "/guide/" },
-            { text: "Using Fontist in CI", link: "/guide/ci" },
-            { text: "Fontist with Fontconfig", link: "/guide/fontconfig" },
-            { text: "Using Fontist with a proxy", link: "/guide/proxy" },
-            {
-              text: "Create a new Fontist Formula",
-              link: "https://fontist.org/formulas/guide/create-formula",
-              target: "_self",
-            },
+            { text: "Manifests", link: "/guide/manifests" },
+            { text: "Formulas", link: "/guide/formulas" },
           ],
         },
         {
-          text: "API",
+          text: "Guides",
+          collapsed: true,
           items: [
-            { text: "Fontist Ruby library", link: "/guide/api-ruby" },
+            { text: "CI/CD Integration", link: "/guide/ci" },
+            { text: "Fontconfig", link: "/guide/fontconfig" },
+            { text: "Proxy Setup", link: "/guide/proxy" },
             {
-              text: "Ruby API reference",
-              link: "https://fontist.org/fontist/reference/api-ruby/",
+              text: "Create a Formula",
+              link: "https://www.fontist.org/formulas/guide/create-formula",
               target: "_self",
             },
           ],
         },
+        {
+          text: "Platforms",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/platforms/" },
+            { text: "macOS", link: "/guide/platforms/macos" },
+            { text: "Windows", link: "/guide/platforms/windows" },
+          ],
+        },
+        {
+          text: "Maintainer Docs",
+          collapsed: true,
+          items: [
+            { text: "Overview", link: "/guide/maintainer/" },
+            { text: "Importing Fonts", link: "/guide/maintainer/import" },
+          ],
+        },
       ],
-      "/reference/": [
+      "/cli/": [
+        {
+          text: "CLI Reference",
+          items: [
+            { text: "Overview", link: "/cli/" },
+          ],
+        },
+        {
+          text: "Core Commands",
+          items: [
+            { text: "install", link: "/cli/install" },
+            { text: "uninstall", link: "/cli/uninstall" },
+            { text: "list", link: "/cli/list" },
+            { text: "status", link: "/cli/status" },
+            { text: "update", link: "/cli/update" },
+            { text: "version", link: "/cli/version" },
+          ],
+        },
+        {
+          text: "Subcommands",
+          collapsed: true,
+          items: [
+            { text: "manifest", link: "/cli/manifest" },
+            { text: "cache", link: "/cli/cache" },
+            { text: "config", link: "/cli/config" },
+            { text: "repo", link: "/cli/repo" },
+            { text: "fontconfig", link: "/cli/fontconfig" },
+            { text: "import", link: "/cli/import" },
+            { text: "index", link: "/cli/index-cmd" },
+            { text: "create-formula", link: "/cli/create-formula" },
+          ],
+        },
         {
           text: "Reference",
+          collapsed: true,
           items: [
-            { text: "Fontist CLI reference", link: "/reference/" },
-            {
-              text: "Ruby API reference",
-              link: "https://fontist.org/fontist/reference/api-ruby/",
-              target: "_self",
-            },
+            { text: "Exit Codes", link: "/cli/exit-codes" },
+          ],
+        },
+      ],
+      "/api/": [
+        {
+          text: "API Reference",
+          items: [
+            { text: "Overview", link: "/api/" },
+          ],
+        },
+        {
+          text: "Classes",
+          items: [
+            { text: "Fontist::Font", link: "/api/font" },
+            { text: "Fontist::Formula", link: "/api/formula" },
+            { text: "Fontist::Manifest", link: "/api/manifest" },
+            { text: "Fontist::Fontconfig", link: "/api/fontconfig" },
+          ],
+        },
+        {
+          text: "Errors",
+          collapsed: true,
+          items: [
+            { text: "Fontist::Errors", link: "/api/errors" },
           ],
         },
       ],
@@ -77,7 +215,7 @@ export default defineConfig({
 
     footer: {
       message: `Fontist is <a href="https://open.ribose.com/">riboseopen</a>`,
-      copyright: `Copyright &copy; 2023 Ribose Group Inc. All rights reserved.`,
+      copyright: `Copyright &copy; 2026 Ribose Group Inc. All rights reserved.`,
     },
   },
 });