# Docs Build

Build, preview, and validate the Uno documentation website (DocFX) locally, surface...

- Repository: https://github.com/unoplatform/uno (10099 stars)
- Category: Testing
- License: Apache-2.0
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add unoplatform/uno --skill docs-build -g -a claude-code -y`
Codex: `npx skills add unoplatform/uno --skill docs-build -g -a codex -y`
Cursor: `npx skills add unoplatform/uno --skill docs-build -g -a cursor -y`
Gemini CLI: `npx skills add unoplatform/uno --skill docs-build -g -a gemini-cli -y`

## Description

Build, preview, and validate the Uno documentation website (DocFX) locally, surface real content errors vs expected noise, drive rendered pages with Playwright, and validate external-doc commit bumps in import_external_docs.ps1 before a PR. Use when working under doc/, editing articles/** markdown, bumping an external docs ref (uno.themes, studio-docs, hd-docs, uno.chefs, workshops, …), or rendering/validating the docs site.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Docs build & validation (DocFX)

Validate that the documentation is **correct** after a change: surface DocFX errors/warnings, drive
the rendered site in a real browser, and tell real content problems apart from expected noise.
Everything is under `doc/` and is **independent of the Uno.UI build**, no
`crosstargeting_override.props` needed.

## TL;DR validation loop

```bash
cd doc
docfx --version                                   # MUST match build/Uno.UI.Build.csproj <DocfxVersion>; see Gotchas
pwsh -NoProfile -Command "./import_external_docs.ps1"   # only if you changed external pins
docfx docfx.json 2>&1 | sed -E 's/\x1b\[[0-9;]*m//g' > /tmp/docfx.log   # capture clean (no color) log
grep -iE "error|warning" /tmp/docfx.log | sort | uniq -c | sort -rn      # triage
```
Then filter to the part you changed (§2), drive the rendered pages in a browser (§3), and confirm
they exist in `_site`.

## 1. The error/warning taxonomy, what each one means

DocFX prints `error` and `warning` lines. The ones that indicate a **real content problem you
must fix** (and that block/break a page):

The rest: https://github.com/unoplatform/uno/blob/HEAD/.claude/skills/docs-build/SKILL.md