Repository navigation
docs: bump comark-docs layer and lint docs content - #107
Merged
Merged
Conversation
- Pin the layer after comarkdown/comark-docs#79 and #80. - Rename the u-* content components the layer no longer registers globally. - Fix 7 links to heading ids that the new layer no longer generates. - Serve the bxl, catppuccin and circle-flags icons, which the layer no longer fetches from Iconify. - Add comark-lint.config.ts and run comark-lint in CI through lint:docs. Amp-Thread-ID: https://ampcode.com/threads/T-01a18c64-cf17-72b6-afc0-24d664666b30
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR moves the docs site to the current
comark-docslayer and lints the docs content in CI.4fcfb4f(after fix: bump the content cache version and re-export Nuxt UI's button instead of global u- components comarkdown/comark-docs#79 and feat: add a highlighter option for content code blocks comarkdown/comark-docs#80).u-*components globally.docs/content/index.mdnow uses::landing-heroand::button.::landing-tabssection uses the layer'sheader: center, so the header spans both columns and the terminal panel lines up with the tab list.docs/comark-lint.config.tsextends the layer's lint preset with the three components that thecomponents:extendhook makes global. A new rootlint:docsscript runscomark-lint. The CIlintstep andpnpm cirun it.The lint found 7 links that the bump breaks. The new layer gives a nested heading its own slug, for example
#baseline, not#x18n-check-baseline. The links to/surfaces/cli#x18n-check-baseline,#x18n-check-reporters,/plugins/yaml#sections-placeholdersand#sections-scannersnow use the new ids. Three are in hand-written pages, and four come fromdocs/scripts/generate.tsanddocs/scripts/notes.ts, so the generated pages are regenerated.The bump also stops two kinds of icons from rendering. The old layer fetched any icon from the Iconify API. The new layer serves only installed collections.
@iconify-json/bxl(the VS Code logo) and@iconify-json/circle-flags(the locale flags in the demos) are not installed.catppuccinworked only through another package. This PR adds the three collections todocs/package.jsonand toicon.serverBundle.collections. The flags need the server bundle because their names come from data (i-circle-flags-${flag}), so the client bundle scan does not find them.pnpm installrefused three Vercel packages with "High-risk trust downgrade", so@vercel/functions@3.10.5,@vercel/oidc@4.0.5, and@vercel/cli-config@0.3.5are added totrustPolicyExclude. They are published fromvercel/vercelthrough npm trusted publishing, with no provenance attestation.Verification
pnpm run lint:docs: No problems. Before the fixes: 7 broken anchors and 10 unknown-component reports for the three site components.pnpm lint,pnpm knip: no issues.pnpm typecheck: 15 of 15 tasks pass.pnpm test --run(builds first): 808 tests in 59 files pass.x18n check --strict: no errors.pnpm -C docs run docs:build: the build completes.nuxt dev:/has no rawu-*orlanding-herotags. The 7 links point to#baseline,#reporters,#placeholdersand#scanners, and the target pages have those ids. Clicking the link on/surfaces/ciopens/surfaces/cli#baselineat the Baseline heading.nuxt dev, Interactive UI and VS Code tabs: thebxl,circle-flagsandcatppuccinicons render, the same as on x18n.dev. Without the icon change, the VS Code logo and the five flags were empty./renders the hero with no rawu-*orlanding-herotags./surfaces/cliand/plugins/yamlhave thebaseline,reporters,placeholdersandscannersids./api/_nuxt_iconserves thecircle-flags,bxlandcatppuccinicons that the demos use.pnpm -C docs run generatein my environment also reorders the "Source" lists ofdocs/content/7.errors/x18n2002.mdtox18n2004.md.sourceFiles()keepsreaddirorder, which depends on the file system. Those changes are not in this PR.Written by an AI agent (Amp) on behalf of @atinux.