chore: textlintを導入 (#83)

Signed-off-by: Shunsuke Kimura <[email protected]>
Co-authored-by: Shunsuke KIMURA <[email protected]>

Author: 3w36zj6

.github/workflows/deploy.yml

@@ -1,27 +1,66 @@
-# Based on ripgrep's release action:
-# https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/release.yml
-
 name: CI/CD for Documentation
-on: [push, pull_request]
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
 permissions:
   contents: write
+
 jobs:
   build-and-deploy:
-    name: build-and-deploy
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: '1.77'
+          toolchain: "1.77"
       - uses: Swatinem/rust-cache@v2
       - uses: jdx/mise-action@v2
       - run: uv sync --locked
       - run: mise run generate-docs
       - run: mise run generate-web
-      # deploy ./dist to https://github.com/typst-doc-cn/typst-doc-cn.github.io
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts
+          path: dist
       - name: Deploy
         if: github.ref == 'refs/heads/main'
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: dist # The folder the action should deploy.
+
+  textlint-md:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+      - name: Setup tools
+        uses: jdx/mise-action@v2
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+      - name: Lint Markdown using textlint
+        run: bun run --bun textlint-md
+        continue-on-error: true
+
+  textlint-html:
+    runs-on: ubuntu-24.04
+    needs: build-and-deploy
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: build-artifacts
+          path: dist
+      - uses: jdx/mise-action@v2
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+      - name: Lint HTML using textlint
+        run: bun run --bun textlint-html
+        continue-on-error: true

.mise.toml

@@ -1,6 +1,8 @@
 [tools]
 # python is managed by .python-version
 uv = "0.5.1"
+node = "22.11.0"
+bun = "1.1.37"
 
 [env]
 _.python.venv = { path = ".venv", create = true }

.textlintignore

@@ -0,0 +1,3 @@
+# hayagrivaのsrc/csl/archive.rsで管理されている参考文献フォーマット
+dist/docs/reference/model/bibliography/index.html
+dist/docs/reference/model/cite/index.html

.textlintrc.js

@@ -0,0 +1,15 @@
+// @ts-check
+
+/** @type {import("@textlint/config-loader").TextlintConfigDescriptor} */
+module.exports = {
+  plugins: ["html"],
+  filters: {
+    comments: true,
+  },
+  rules: {
+    "preset-jtf-style": {
+      // 階層構造を表現する記号としての>の使用例があるため
+      "4.3.7.山かっこ<>": false,
+    },
+  },
+};

bun.lockb

@@ -25,15 +25,15 @@ description: Changes in Typst 0.1.0
   gives access to the automatically resolved kind, supplement, and counter
 
 ## Bibliography improvements
-- The [`bibliography`] now also accepts multiple bibliography paths (as an
+- The [`bibliography`]($bibliography) now also accepts multiple bibliography paths (as an
   array)
 - Parsing of BibLaTeX files is now more permissive (accepts non-numeric edition,
   pages, volumes, dates, and Jabref-style comments; fixed abbreviation parsing)
 - Labels and references can now include `:` and `.` except at the end
 - Fixed APA bibliography ordering
 
 ## Drawing additions
-- Added [`polygon`] function for drawing polygons
+- Added [`polygon`]($polygon) function for drawing polygons
 - Added support for clipping in [boxes]($box.clip) and [blocks]($block.clip)
 
 ## Command line interface
@@ -44,12 +44,12 @@ description: Changes in Typst 0.1.0
 - Added `--open` flag to directly open the PDF
 
 ## Miscellaneous improvements
-- Added [`yaml`] function to load data from YAML files
+- Added [`yaml`]($yaml) function to load data from YAML files
 - Added basic i18n for a few more languages (IT, RU, ZH, FR, PT)
 - Added numbering support for Hebrew
 - Added support for [integers]($int) with base 2, 8, and 16
 - Added symbols for double bracket and laplace operator
-- The [`link`] function now accepts [labels]($label)
+- The [`link`]($link) function now accepts [labels]($label)
 - The link syntax now allows more characters
 - Improved justification of Japanese and Chinese text
 - Calculation functions behave more consistently w.r.t to non-real results
@@ -63,7 +63,7 @@ description: Changes in Typst 0.1.0
 - Fixed invalid parsing of language tag in raw block with a single backtick
 - Fixed bugs with displaying counters and state
 - Fixed crash related to page counter
-- Fixed crash when [`symbol`] function was called without arguments
+- Fixed crash when [`symbol`]($symbol) function was called without arguments
 - Fixed crash in bibliography generation
 - Fixed access to label of certain content elements
 - Fixed line number in error message for CSV parsing

docs/changelog/0.1.0.md

@@ -53,7 +53,7 @@ description: Changes in Typst 0.10.0
 - Changed default [figure supplement]($figure.supplement) for Russian to short
   form
 - Fixed [CJK-Latin-spacing]($text.cjk-latin-spacing) before line breaks and in
-  [`locate`] calls
+  [`locate`]($locate) calls
 - Fixed line breaking at the end of links
 
 ## Math
@@ -67,13 +67,13 @@ description: Changes in Typst 0.10.0
 ## Scripting
 - Any non-identifier dictionary key is now interpreted as an expression: For
   instance, `{((key): value)}` will create a dictionary with a dynamic key
-- The [`stroke`] type now has a constructor that converts a value to a stroke or
+- The [`stroke`]($stroke) type now has a constructor that converts a value to a stroke or
   creates one from its parts
-- Added constructor for [`arguments`] type
+- Added constructor for [`arguments`]($arguments) type
 - Added [`calc.div-euclid`]($calc.div-euclid) and
   [`calc.rem-euclid`]($calc.rem-euclid) functions
-- Fixed equality of [`arguments`]
-- Fixed [`repr`]of [`cmyk`]($color.cmyk) colors
+- Fixed equality of [`arguments`]($arguments)
+- Fixed [`repr`]($repr) of [`cmyk`]($color.cmyk) colors
 - Fixed crashes with provided elements like figure captions, outline entries,
   and footnote entries
 
@@ -115,10 +115,10 @@ description: Changes in Typst 0.10.0
   just a string
 - The [`number-align`]($enum.number-align) parameter on numbered lists now also
   accepts vertical alignments
-- Fixed selectors on [quote] elements
+- Fixed selectors on [quote]($quote) elements
 - Fixed parsing of `[#return]` expression in markup
 - Fixed bug where inline equations were displayed in equation outlines
-- Fixed potential CRLF issue in [`raw`] blocks
+- Fixed potential CRLF issue in [`raw`]($raw) blocks
 - Fixed a bug where Chinese numbering couldn't exceed the number 255
 
 ## Development

docs/changelog/0.10.0.md

@@ -8,15 +8,15 @@ description: Changes in Typst 0.11.0
 ## Tables
 - Tables are now _much_ more flexible, read the new
   [table guide]($guides/table-guide) to get started
-- Added [`table.cell`] element for per-cell configuration
+- Added [`table.cell`]($table.cell) element for per-cell configuration
 - Cells can now span multiple [columns]($table.cell.colspan) or
   [rows]($table.cell.rowspan)
 - The [stroke]($table.cell.stroke) of individual cells can now be customized
 - The [`align`]($table.align) and [`inset`]($table.inset) arguments of the table
   function now also take `{(x, y) => ..}` functions
-- Added [`table.hline`] and [`table.vline`] for convenient line customization
-- Added [`table.header`] element for table headers that repeat on every page
-- Added [`table.footer`] element for table footers that repeat on every page
+- Added [`table.hline`]($table.hline) and [`table.vline`]($table.vline) for convenient line customization
+- Added [`table.header`]($table.header) element for table headers that repeat on every page
+- Added [`table.footer`]($table.footer) element for table footers that repeat on every page
 - All the new table functionality is also available for [grids]($grid)
 - Fixed gutter-related bugs
 
@@ -40,32 +40,32 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   [disciplines](https://github.com/typst/packages/blob/main/DISCIPLINES.md).
 
 ## Context
-- Added _context expressions:_ Read the chapter on [context] to get started
+- Added _context expressions:_ Read the chapter on [context]($context) to get started
 - With context, you can access settable properties, e.g. `{context text.lang}`
   to access the language set via `{set text(lang: "..")}`
-- The following existing functions have been made contextual: [`query`],
-  [`locate`], [`measure`], [`counter.display`], [`counter.at`],
-  [`counter.final`], [`state.at`], and [`state.final`]
-- Added contextual methods [`counter.get`] and [`state.get`] to retrieve the
+- The following existing functions have been made contextual: [`query`]($query),
+  [`locate`]($locate), [`measure`]($measure), [`counter.display`]($counter.display), [`counter.at`]($counter.at),
+  [`counter.final`]($counter.final), [`state.at`]($state.at), and [`state.final`]($state.final)
+- Added contextual methods [`counter.get`]($counter.get) and [`state.get`]($state.get) to retrieve the
   value of a counter or state in the current context
-- Added contextual function [`here`] to retrieve the [location] of the current
+- Added contextual function [`here`]($here) to retrieve the [location]($location) of the current
   context
-- The [`locate`] function now returns the location of a selector's unique match.
+- The [`locate`]($locate) function now returns the location of a selector's unique match.
   Its old behavior has been replaced by context expressions and only remains
   temporarily available for compatibility.
-- The [`counter.at`] and [`state.at`] methods are now more flexible: They
+- The [`counter.at`]($counter.at) and [`state.at`]($state.at) methods are now more flexible: They
   directly accept any kind of [locatable]($location/#locatable) selector with a
   unique match (e.g. a label) instead of just locations
-- When context is available, [`counter.display`] now directly returns the result
+- When context is available, [`counter.display`]($counter.display) now directly returns the result
   of applying the numbering instead of yielding opaque content. It should not be
   used anymore without context. (Deprecation planned)
-- The [`state.display`] function should not be used anymore, use [`state.get`]
+- The [`state.display`]($state.display) function should not be used anymore, use [`state.get`]($state.get)
   instead (Deprecation planned)
-- The `location` argument of [`query`], [`counter.final`], and [`state.final`]
+- The `location` argument of [`query`]($query), [`counter.final`]($counter.final), and [`state.final`]($state.final)
   should not be used anymore (Deprecation planned)
 - The [`styles`]($measure.styles) argument of the `measure` function should not
   be used anymore (Deprecation planned)
-- The [`style`] function should not be used anymore, use context instead
+- The [`style`]($style) function should not be used anymore, use context instead
   (Deprecation planned)
 - The correct context is now also provided in various other places where it is
   available, e.g. in show rules, layout callbacks, and numbering functions in
@@ -89,7 +89,7 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   show rules
 - Errors within show rules and context expressions are now ignored in all but
   the last introspection iteration, in line with the behavior of the old
-  [`locate`]
+  [`locate`]($locate)
 - Fixed a bug where document set rules were allowed after content
 
 ## Layout
@@ -98,9 +98,9 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
 - Fixed a bug where [floating placement]($place.float) or
   [floating figures]($figure.placement) could end up out of order
 - Fixed overlap of text and figure for full-page floating figures
-- Fixed various cases where the [`hide`] function didn't hide its contents
+- Fixed various cases where the [`hide`]($hide) function didn't hide its contents
   properly
-- Fixed usage of [`h`] and [`v`] in [stacks]($stack)
+- Fixed usage of [`h`]($h) and [`v`]($v) in [stacks]($stack)
 - Invisible content like a counter update will no longer force a visible block
   for just itself
 - Fixed a bug with horizontal spacing followed by invisible content (like a
@@ -109,7 +109,7 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
 ## Text
 - Added [`stroke`]($text.stroke) property for text
 - Added basic i18n for Serbian and Catalan
-- Added support for contemporary Japanese [numbering] method
+- Added support for contemporary Japanese [numbering]($numbering) method
 - Added patches for various wrong metadata in specific fonts
 - The [text direction]($text.dir) can now be overridden within a paragraph
 - Fixed Danish [smart quotes]($smartquote)
@@ -125,9 +125,9 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   heading to increase or decrease the heading level for a bunch of content; the
   heading syntax now sets `depth` rather than `level` **(Breaking change)**
 - List [markers]($list.marker) now cycle by default
-- The [`quote`] function now more robustly selects the correct quotes based on
+- The [`quote`]($quote) function now more robustly selects the correct quotes based on
   language and nesting
-- Fixed indent bugs related to the default show rule of [terms]
+- Fixed indent bugs related to the default show rule of [terms]($terms)
 
 ## Math
 - Inline equations now automatically linebreak at appropriate places
@@ -137,10 +137,10 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
 - Improved positioning of accents
 - [Primes]($math.primes) are now always attached as [scripts]($math.scripts) by
   default
-- Exposed [`math.primes`] element which backs the `[$f'$]` syntax in math
-- Math mode is not affected by [`strong`] and [`emph`] anymore
+- Exposed [`math.primes`]($math.primes) element which backs the `[$f'$]` syntax in math
+- Math mode is not affected by [`strong`]($strong) and [`emph`]($emph) anymore
 - Fixed [`attach`]($math.attach) under [fractions]($math.frac)
-- Fixed that [`math.class`] did not affect smart limit placement
+- Fixed that [`math.class`]($math.class) did not affect smart limit placement
 - Fixed weak spacing in [`lr`]($math.lr) groups
 - Fixed layout of large operators for Cambria Math font
 - Fixed math styling of Hebrew symbol codepoints
@@ -161,19 +161,19 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
 - Arrays can now be compared lexicographically
 - Added contextual method [`to-absolute`]($length.to-absolute) to lengths
 - Added [`calc.root`]($calc.root)
-- Added [`int.signum`] and [`float.signum`] methods
-- Added [`float.is-nan`] and [`float.is-infinite`] methods
-- Added [`int.bit-not`], [`int.bit-and`], [`int.bit-or`], [`int.bit-xor`],
-  [`int.bit-lshift`], and [`int.bit-rshift`] methods
-- Added [`array.chunks`] method
+- Added [`int.signum`]($int.signum) and [`float.signum`]($float.signum) methods
+- Added [`float.is-nan`]($float.is-nan) and [`float.is-infinite`]($float.is-infinite) methods
+- Added [`int.bit-not`]($int.bit-not), [`int.bit-and`]($int.bit-and), [`int.bit-or`]($int.bit-or), [`int.bit-xor`]($int.bit-xor),
+  [`int.bit-lshift`]($int.bit-lshift), and [`int.bit-rshift`]($int.bit-rshift) methods
+- Added [`array.chunks`]($array.chunks) method
 - A module can now be converted to a dictionary with the
   [dictionary constructor]($dictionary/#constructor) to access its contents
   dynamically
 - Added [`row-type`]($csv.row-type) argument to `csv` function to configure
   how rows will be represented
 - [XML parsing]($xml) now allows DTDs (document type definitions)
 - Improved formatting of negative numbers with [`str`]($str) and [`repr`]($repr)
-- For loops can now iterate over [bytes]
+- For loops can now iterate over [bytes]($bytes)
 - Fixed a bug with pattern matching in for loops
 - Fixed a bug with labels not being part of [`{.fields()}`]($content.fields)
   dictionaries
@@ -186,7 +186,7 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   instead of being collapsed into normal spaces **(Breaking change)**
 - Korean text can now use emphasis syntax without adding spaces
   **(Breaking change)**
-- The token [`context`] is now a keyword and cannot be used as an identifier
+- The token [`context`]($context) is now a keyword and cannot be used as an identifier
   anymore **(Breaking change)**
 - Nested line comments aren't allowed anymore in block comments
   **(Breaking change)**
@@ -197,7 +197,7 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   dictionaries
 
 ## Tooling & Diagnostics
-- Click-to-jump now works properly within [`raw`] text
+- Click-to-jump now works properly within [`raw`]($raw) text
 - Added suggestion for accessing a field if a method doesn't exist
 - Improved hint for calling a function stored in a dictionary
 - Improved errors for mutable accessor functions on arrays and dictionaries
@@ -208,23 +208,23 @@ _Thanks to [@PgBiel](https://github.com/PgBiel) for his work on tables!_
   namespaces
 
 ## Visualization
-- The [`image`] function doesn't upscale images beyond their natural size
+- The [`image`]($image) function doesn't upscale images beyond their natural size
   anymore
-- The [`image`] function now respects rotation stored in EXIF metadata
+- The [`image`]($image) function now respects rotation stored in EXIF metadata
 - Added support for SVG filters
 - Added alpha component to [`luma`]($color.luma) colors
-- Added [`color.transparentize`] and [`color.opacify`] methods
-- Improved [`color.negate`] function
+- Added [`color.transparentize`]($color.transparentize) and [`color.opacify`]($color.opacify) methods
+- Improved [`color.negate`]($color.negate) function
 - Added [`stroke`]($highlight.stroke) and [`radius`]($highlight.radius)
   arguments to `highlight` function
-- Changed default [`highlight`] color to be transparent
+- Changed default [`highlight`]($highlight) color to be transparent
 - CMYK to RGB conversion is now color-managed
 - Fixed crash with gradients in Oklch color space
 - Fixed color-mixing for hue-based spaces
 - Fixed bugs with color conversion
 - SVG sizes are not rounded anymore, preventing slightly wrong aspect ratios
 - Fixed a few other SVG-related bugs
-- [`color.components`] doesn't round anything anymore
+- [`color.components`]($color.components) doesn't round anything anymore
 
 ## Export
 - PDFs now contain named destinations for headings derived from their labels

docs/changelog/0.11.0.md

@@ -18,11 +18,11 @@ description: Changes in Typst 0.11.1
 
 ## Text and Layout
 - Fixed interaction of [`first-line-indent`]($par.first-line-indent) and
-  [`outline`]
+  [`outline`]($outline)
 - Fixed compression of CJK punctuation marks at line start and end
 - Fixed handling of [rectangles]($rect) with negative dimensions
-- Fixed layout of [`path`] in explicitly sized container
-- Fixed broken [`raw`] text in right-to-left paragraphs
+- Fixed layout of [`path`]($path) in explicitly sized container
+- Fixed broken [`raw`]($raw) text in right-to-left paragraphs
 - Fixed tab rendering in `raw` text with language `typ` or `typc`
 - Fixed highlighting of multi-line `raw` text enclosed by single backticks
 - Fixed indentation of overflowing lines in `raw` blocks