Skip to content

feat(docs): add syntax highlighting + restructure community contributing section#728

Merged
ss-o merged 13 commits into
nextfrom
feature-syntax-highlighting
May 19, 2026
Merged

feat(docs): add syntax highlighting + restructure community contributing section#728
ss-o merged 13 commits into
nextfrom
feature-syntax-highlighting

Conversation

@ss-o
Copy link
Copy Markdown
Member

@ss-o ss-o commented May 16, 2026

Summary

Syntax highlighting

  • Register Z-Shell language with Prism via src/prism-zshell.js
  • Apply to relevant code blocks in docs

Community contributing section restructure

Creates community/00_contributing/ as the first-priority section — a comprehensive contributing hub for the Z-Shell ecosystem.

New pages:

  • index.mdx — overview with banner SVG + 3-column card grid
  • 01_getting_started.mdx — org-wide fork/branch/commit/PR guide
  • 02_contributing_to_zi.mdx — Zi-specific contributing guide
  • 03_zsh_plugin_standard.mdx — moved from community root (slug preserved)
  • 04_contributing_docs.mdx — wiki MDX authoring and Crowdin guide
  • 05_project_management.mdx — absorbs tracker + labels branch content

SVG illustrations added to static/img/svg/community/:

  • contributing-banner.svg — wide fork→code→PR→merge workflow diagram
  • Five 120×120 icons for each sub-page (git branch, gear, plug, document, kanban)

Housekeeping:

  • Renumbered 03_zsh_native_scripting_handbook02_, 04_zunit/03_zunit/
  • Fixed all ZUnit broken links (file-based .mdx extension approach)
  • Absorbs docs/project-tracker-and-labels branch (now deleted)

Closes #727 follow-up (ZUnit links)

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 16, 2026

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: 29b0ebf
Status: ✅  Deploy successful!
Preview URL: https://74f1e347.zsh.pages.dev
Branch Preview URL: https://feature-syntax-highlighting.zsh.pages.dev

View logs

@ss-o ss-o changed the title feat(docs): add z-shell syntax highlighting feat(docs): add syntax highlighting + restructure community contributing section May 16, 2026
@ss-o ss-o marked this pull request as ready for review May 17, 2026 04:45
Copilot AI review requested due to automatic review settings May 17, 2026 04:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds custom Prism languages for Zsh/Zi/ZUnit and updates docs/community content to use them, while restructuring the Community “Contributing” area into a dedicated hub section.

Changes:

  • Add Prism language registration (zsh/zi/zunit) and wire it into Docusaurus’ Prism language loading.
  • Update many docs code fences from shell to more specific languages (zsh, zi, zunit) to improve highlighting.
  • Create a new community/00_contributing/ hub (overview page + subpages) and renumber/move Community sections (incl. ZUnit).

Reviewed changes

Copilot reviewed 71 out of 82 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
static/img/svg/community/contributing-zi.svg Add Zi contributing icon SVG
static/img/svg/community/contributing-project-management.svg Add project management icon SVG
static/img/svg/community/contributing-plugin-standard.svg Add plugin standard icon SVG
static/img/svg/community/contributing-getting-started.svg Add getting started icon SVG
static/img/svg/community/contributing-docs.svg Add docs contributing icon SVG
static/img/svg/community/contributing-banner.svg Add contributing banner SVG
src/theme/prism-include-languages.ts Include Prism additional languages + register custom Zsh/Zi/ZUnit languages
src/prism/z-shell-languages.ts Define Prism grammars for zsh, zi, zunit
package.json Add prismjs + @types/prismjs dependencies
pnpm-lock.yaml Lockfile update for Prism deps
ecosystem/plugins/zzcomplete.mdx Update code fence language to zsh
ecosystem/plugins/zui.mdx Update code fence language to zsh
ecosystem/plugins/zsh_unique_id.mdx Update code fence language to zsh
ecosystem/plugins/zsh_startify.mdx Update code fence language to zsh
ecosystem/plugins/zsh_select.mdx Update code fence language to zsh
ecosystem/plugins/zsh_navigation_tools.mdx Update code fence language to zsh
ecosystem/plugins/zsh_modules.mdx Update code fence language to zsh
ecosystem/plugins/zsh_editing_workbench.mdx Update code fence language to zsh
ecosystem/plugins/zsh_comand_architect.mdx Update code fence language to zsh
ecosystem/plugins/zprompts.mdx Update code fence language to zsh
ecosystem/plugins/zi_console.mdx Update code fence language to zsh
ecosystem/plugins/zconvey.mdx Update code fence language to zsh
ecosystem/plugins/zbrowse.mdx Update code fence language to zsh
ecosystem/plugins/h-s-mw.mdx Update code fence language to zsh
ecosystem/plugins/f-sy-h.mdx Update code fence language to zsh
ecosystem/plugins/diff-so-fancy.mdx Update code fence language to zsh
ecosystem/packages/01_synopsis.mdx Update code fence language to zsh
ecosystem/packages/02_usage.mdx Update code fence language to zsh
ecosystem/annexes/0_overview.mdx Update Zi-related fences to zi
ecosystem/annexes/1_bin_gem_node.mdx Update code fence language to zsh
ecosystem/annexes/2_meta_plugins.mdx Update code fence language to zsh
ecosystem/annexes/3_default_ice.mdx Update code fence language to zsh
ecosystem/annexes/4_patch-dl.mdx Update code fence language to zsh
ecosystem/annexes/5_readurl.mdx Update code fence language to zsh
ecosystem/annexes/6_submods.mdx Update code fence language to zsh
ecosystem/annexes/7_unscope.mdx Update code fence language to zsh
ecosystem/annexes/8_linkbin.mdx Update code fence language to zsh
ecosystem/annexes/9_rust.mdx Update code fence language to zsh
ecosystem/annexes/19_eval.mdx Update code fence language to zsh
ecosystem/annexes/20_test.mdx Update code fence language to zsh
docs/getting_started/01_installation.mdx Update code fence language to zsh
docs/getting_started/02_overview.mdx Update code fence language to zsh
docs/getting_started/03_migration.mdx Update code fence language to zsh
docs/guides/01_commands.mdx Update Zi-related fences to zi
docs/guides/02_customization.mdx Update code fence language to zsh
docs/guides/03_benchmark.mdx Update code fence language to zsh
docs/guides/syntax/01_standard.mdx Update code fence language to zsh (and adjust one snippet URL)
docs/guides/syntax/02_for.mdx Update code fence language to zsh
docs/guides/syntax/10_bindkey.mdx Update code fence language to zsh
community/index.mdx Add “Contributing” entry point link from Community landing page
community/gallery/collection/01_collection.mdx Update code fence language to zsh
community/gallery/collection/02_completions.mdx Update code fence language to zsh
community/gallery/collection/03_programs.mdx Update code fence language to zsh
community/gallery/collection/04_snippets.mdx Update code fence language to zsh
community/gallery/collection/05_services.mdx Update code fence language to zsh
community/gallery/collection/06_plugins.mdx Update code fence language to zsh
community/gallery/collection/07_themes.mdx Update code fence language to zsh
community/04_zunit/category.json Remove old ZUnit category metadata (section moved/renumbered)
community/03_zunit/category.json Add new ZUnit category metadata (new position/link type)
community/03_zunit/index.mdx Update ZUnit index links to new file layout
community/03_zunit/01_installation.mdx Update internal links to new section docs
community/03_zunit/02_test-syntax.mdx Use zunit fence for ZUnit file syntax examples
community/03_zunit/03_assertions.mdx Use zunit fence for assertion examples
community/03_zunit/04_running-tests.mdx Update CI integration link reference
community/03_zunit/05_configuration.mdx Add new ZUnit configuration reference page
community/03_zunit/06_ci.mdx Add new ZUnit CI integration page
community/02_zsh_native_scripting_handbook.mdx Renumber in sidebar + update fences to zsh
community/01_zsh_guide/01_roadmap/10_expansion.mdx Update fences to zsh
community/00_contributing/category.json Add new “Contributing” category for Community docs
community/00_contributing/index.mdx Add new contributing hub landing page
community/00_contributing/01_getting_started.mdx Add org-wide contributing basics page
community/00_contributing/02_contributing_to_zi.mdx Add Zi-specific contributing guide page
community/00_contributing/03_zsh_plugin_standard.mdx Move/adjust plugin standard page (preserve slug) + update fences
community/00_contributing/04_contributing_docs.mdx Add wiki contribution/how-to page
community/00_contributing/05_project_management.mdx Add org project tracker + labels documentation
.github/instructions/docs-authoring.instructions.md Document preferred code fence languages (zsh, zi, zunit, sh, etc.)
AGENTS.md Add repo-wide guidelines file
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)

AGENTS.md:75

  • This repo already documents that AI-specific global instruction files (including AGENTS.md) should not be introduced unless explicitly requested, but this PR adds AGENTS.md at the repo root. Please remove this file (or relocate the content into the existing .github/instructions/* docs where it belongs).
## Agent Notes

- Prefer small, scoped edits that match surrounding MDX and TypeScript style.
- Link to existing docs rather than duplicating long guidance.
- Scoped instruction files in `.github/instructions/` are auto-applied by file glob — prefer updating those for domain-specific guidance over modifying this file.
- Do not introduce new global instruction files (e.g., `AGENTS.md`) unless explicitly requested.

Comment thread src/theme/prism-include-languages.ts Outdated
Comment thread src/prism/z-shell-languages.ts
Comment thread community/00_contributing/04_contributing_docs.mdx
Comment thread community/00_contributing/01_getting_started.mdx
Comment thread community/00_contributing/05_project_management.mdx
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 17, 2026

Size Change: +260 kB (+4.14%)

Total Size: 6.55 MB

Filename Size Change
.docusaurus/globalData.json 13.5 kB +745 B (+5.84%) 🔍
build/assets/css/styles.********.css 154 kB +1.73 kB (+1.13%)
build/assets/js/073fbc7c.********.js 15.8 kB -524 B (-3.22%)
build/assets/js/09a4fe5a.********.js 64.8 kB -100 B (-0.15%)
build/assets/js/0a6cf40a.********.js 36.9 kB -40 B (-0.11%)
build/assets/js/15965d57.********.js 0 B -8.79 kB (removed) 🏆
build/assets/js/167d542a.********.js 12 kB -31 B (-0.26%)
build/assets/js/21ebe3c8.********.js 0 B -15.4 kB (removed) 🏆
build/assets/js/221b35f7.********.js 17.9 kB -31 B (-0.17%)
build/assets/js/245d11de.********.js 0 B -56.3 kB (removed) 🏆
build/assets/js/40c845af.********.js 31.4 kB -31 B (-0.1%)
build/assets/js/4edc808e.********.js 5.29 kB -9.61 kB (-64.51%) 🏆
build/assets/js/62668ce1.********.js 0 B -526 B (removed) 🏆
build/assets/js/67980e14.********.js 0 B -5.33 kB (removed) 🏆
build/assets/js/70442256.********.js 36 kB -83 B (-0.23%)
build/assets/js/7bf4542e.********.js 18.4 kB -33 B (-0.18%)
build/assets/js/93c7665c.********.js 5.99 kB +3.78 kB (+171%) 🆘
build/assets/js/a21c20db.********.js 45 kB -61 B (-0.14%)
build/assets/js/b4645c50.********.js 0 B -32.5 kB (removed) 🏆
build/assets/js/c9a76886.********.js 0 B -6.9 kB (removed) 🏆
build/assets/js/d2436a2b.********.js 8.59 kB +2.13 kB (+32.88%) 🚨
build/assets/js/d5c68bbd.********.js 42.6 kB -89 B (-0.21%)
build/assets/js/df89e360.********.js 0 B -7.2 kB (removed) 🏆
build/assets/js/e76149f9.********.js 9.46 kB +81 B (+0.86%)
build/assets/js/e9ebadb9.********.js 12.5 kB -47 B (-0.37%)
build/assets/js/eb7ebca6.********.js 30.5 kB -43 B (-0.14%)
build/assets/js/ebed0d07.********.js 5.35 kB +3.32 kB (+163%) 🆘
build/assets/js/ec281f2e.********.js 15.8 kB -61 B (-0.39%)
build/assets/js/fbac8b07.********.js 0 B -6.11 kB (removed) 🏆
build/assets/js/fbfee178.********.js 0 B -8.85 kB (removed) 🏆
build/assets/js/fedb50c8.********.js 44.6 kB -159 B (-0.36%)
build/assets/js/main.********.js 517 kB +4.06 kB (+0.79%)
build/assets/js/runtime~main.********.js 8.17 kB +203 B (+2.55%)
build/community.html 21.8 kB +4.45 kB (+25.65%) 🚨
build/community/category/-collection.html 22.7 kB +219 B (+0.98%)
build/community/category/-gallery-of-invocations.html 17.5 kB +206 B (+1.19%)
build/community/category/-zunit.html 0 B -22.5 kB (removed) 🏆
build/community/contributors.html 26.5 kB +211 B (+0.8%)
build/community/gallery/collection.html 24 kB +215 B (+0.9%)
build/community/gallery/collection/completions.html 76.3 kB +2.39 kB (+3.24%)
build/community/gallery/collection/plugins.html 84.1 kB -846 B (-1%)
build/community/gallery/collection/programs.html 188 kB +323 B (+0.17%)
build/community/gallery/collection/services.html 24.7 kB +235 B (+0.96%)
build/community/gallery/collection/snippets.html 24.4 kB +195 B (+0.81%)
build/community/gallery/collection/themes.html 63.4 kB +93 B (+0.15%)
build/community/zsh_handbook.html 159 kB +1.15 kB (+0.72%)
build/community/zsh_plugin_standard.html 108 kB +992 B (+0.93%)
build/community/zunit.html 28.4 kB +4.01 kB (+16.44%) ⚠️
build/community/zunit/zunit-assertions.html 60.8 kB +13.5 kB (+28.42%) 🚨
build/community/zunit/zunit-configuration.html 31.6 kB +963 B (+3.14%)
build/community/zunit/zunit-installation.html 32.8 kB +1.06 kB (+3.34%)
build/community/zunit/zunit-test-syntax.html 43.7 kB +11.1 kB (+34.15%) 🚨
build/docs.html 20.8 kB -4.89 kB (-19.07%) 👏
build/docs/getting_started/installation.html 62 kB -648 B (-1.03%)
build/docs/getting_started/migration.html 87.5 kB +100 B (+0.11%)
build/docs/getting_started/overview.html 85.8 kB -68 B (-0.08%)
build/docs/guides/benchmark.html 56.8 kB +337 B (+0.6%)
build/docs/guides/commands.html 97.5 kB +1.35 kB (+1.41%)
build/docs/guides/customization.html 85.8 kB +4.45 kB (+5.48%) 🔍
build/docs/guides/syntax/bindkey.html 38.4 kB +354 B (+0.93%)
build/docs/guides/syntax/for.html 70.4 kB +270 B (+0.38%)
build/docs/guides/syntax/standard.html 140 kB +142 B (+0.1%)
build/ecosystem.html 20.7 kB +3.76 kB (+22.21%) 🚨
build/ecosystem/annexes/bin-gem-node.html 114 kB +144 B (+0.13%)
build/ecosystem/annexes/eval.html 37.8 kB -40 B (-0.11%)
build/ecosystem/annexes/meta-plugins.html 38.7 kB -33 B (-0.09%)
build/ecosystem/annexes/overview.html 63.5 kB +784 B (+1.25%)
build/ecosystem/annexes/readurl.html 40.1 kB -40 B (-0.1%)
build/ecosystem/annexes/rust.html 42.3 kB -33 B (-0.08%)
build/ecosystem/packages/synopsis.html 35.2 kB -32 B (-0.09%)
build/ecosystem/packages/usage.html 73.1 kB -164 B (-0.22%)
build/ecosystem/plugins/h-s-mw.html 52.1 kB +1.71 kB (+3.4%)
build/ecosystem/plugins/zi-console.html 35 kB +59 B (+0.17%)
build/ecosystem/plugins/zsh-modules.html 38.5 kB +278 B (+0.73%)
build/ecosystem/plugins/zsh-navigation-tools.html 76.1 kB +789 B (+1.05%)
build/ecosystem/plugins/zsh-unique-id.html 31.4 kB +72 B (+0.23%)
build/ecosystem/plugins/zui.html 173 kB +136 B (+0.08%)
build/assets/js/1c9dc0d9.********.js 20.8 kB +20.8 kB (new file) 🆕
build/assets/js/2137bacb.********.js 8.88 kB +8.88 kB (new file) 🆕
build/assets/js/39724810.********.js 14 kB +14 kB (new file) 🆕
build/assets/js/56bcdb4b.********.js 10.3 kB +10.3 kB (new file) 🆕
build/assets/js/62b83c0f.********.js 8.01 kB +8.01 kB (new file) 🆕
build/assets/js/66fe25d9.********.js 6.91 kB +6.91 kB (new file) 🆕
build/assets/js/7aa168bf.********.js 6.16 kB +6.16 kB (new file) 🆕
build/assets/js/7b9e4520.********.js 11.4 kB +11.4 kB (new file) 🆕
build/assets/js/7db88304.********.js 15.5 kB +15.5 kB (new file) 🆕
build/assets/js/7efa72d3.********.js 7.22 kB +7.22 kB (new file) 🆕
build/assets/js/8449122f.********.js 56.4 kB +56.4 kB (new file) 🆕
build/assets/js/d66fa391.********.js 32.4 kB +32.4 kB (new file) 🆕
build/assets/js/e9814e3e.********.js 7.46 kB +7.46 kB (new file) 🆕
build/assets/js/f7eabd91.********.js 8.77 kB +8.77 kB (new file) 🆕
build/community/contributing.html 24.4 kB +24.4 kB (new file) 🆕
build/community/contributing/contributing_docs.html 38.3 kB +38.3 kB (new file) 🆕
build/community/contributing/contributing_to_zi.html 31.6 kB +31.6 kB (new file) 🆕
build/community/contributing/getting_started.html 33.6 kB +33.6 kB (new file) 🆕
build/community/contributing/project_management.html 35.2 kB +35.2 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
build/404.html 10.9 kB 0 B
build/assets/js/0058b4c6.********.js 4.26 kB +13 B (+0.31%)
build/assets/js/0fd216e9.********.js 9.43 kB -19 B (-0.2%)
build/assets/js/12cfd228.********.js 7.17 kB 0 B
build/assets/js/1448.********.js 101 B 0 B
build/assets/js/14eb3368.********.js 10.6 kB 0 B
build/assets/js/175b49cb.********.js 39.4 kB 0 B
build/assets/js/17896441.********.js 1.79 kB 0 B
build/assets/js/1a4e3797.********.js 82.6 kB 0 B
build/assets/js/1b355a49.********.js 8.52 kB -17 B (-0.2%)
build/assets/js/1df93b7f.********.js 16.7 kB 0 B
build/assets/js/1f391b9e.********.js 2.99 kB 0 B
build/assets/js/263b985f.********.js 37 kB -17 B (-0.05%)
build/assets/js/2e789afb.********.js 74.9 kB -19 B (-0.03%)
build/assets/js/3044.********.js 451 B 0 B
build/assets/js/35475145.********.js 451 B 0 B
build/assets/js/36994c47.********.js 171 B 0 B
build/assets/js/3894e54f.********.js 21.9 kB -23 B (-0.1%)
build/assets/js/3a9ef7ca.********.js 439 B 0 B
build/assets/js/3dd168bd.********.js 17.4 kB -15 B (-0.09%)
build/assets/js/3fc333ae.********.js 31 kB -15 B (-0.05%)
build/assets/js/4180.********.js 10.3 kB 0 B
build/assets/js/4382960e.********.js 9.82 kB -15 B (-0.15%)
build/assets/js/446e416b.********.js 9.56 kB -21 B (-0.22%)
build/assets/js/47a5fc0a.********.js 174 B 0 B
build/assets/js/55b84506.********.js 12.3 kB -29 B (-0.23%)
build/assets/js/5665.********.js 101 B 0 B
build/assets/js/573f7f56.********.js 3.29 kB -19 B (-0.57%)
build/assets/js/57a8643e.********.js 14.3 kB -15 B (-0.1%)
build/assets/js/5883.********.js 15 kB 0 B
build/assets/js/5c2e370e.********.js 487 B 0 B
build/assets/js/5e95c892.********.js 338 B 0 B
build/assets/js/6091.********.js 175 kB 0 B
build/assets/js/621db11d.********.js 19.6 kB 0 B
build/assets/js/635ad0e8.********.js 490 B -13 B (-2.58%)
build/assets/js/6be15ea1.********.js 9.37 kB 0 B
build/assets/js/78a4fd52.********.js 4.94 kB -2 B (-0.04%)
build/assets/js/7917.********.js 27.4 kB 0 B
build/assets/js/7c5c12ac.********.js 9.68 kB -15 B (-0.15%)
build/assets/js/814f3328.********.js 151 B 0 B
build/assets/js/8357758b.********.js 19.7 kB -23 B (-0.12%)
build/assets/js/8406.********.js 938 B 0 B
build/assets/js/8525.********.js 1.27 kB 0 B
build/assets/js/8721.********.js 443 kB 0 B
build/assets/js/8894.********.js 102 B 0 B
build/assets/js/8975.********.js 5.79 kB 0 B
build/assets/js/9170.********.js 1.05 kB 0 B
build/assets/js/945b49d0.********.js 14.3 kB -4 B (-0.03%)
build/assets/js/98822c48.********.js 12.9 kB -23 B (-0.18%)
build/assets/js/991ed628.********.js 17.1 kB -19 B (-0.11%)
build/assets/js/9b0b65a6.********.js 11.2 kB -19 B (-0.17%)
build/assets/js/a7456010.********.js 173 B 0 B
build/assets/js/a7bd4aaa.********.js 687 B 0 B
build/assets/js/a821d7a1.********.js 14.9 kB -17 B (-0.11%)
build/assets/js/a94703ab.********.js 11.4 kB 0 B
build/assets/js/aba21aa0.********.js 172 B 0 B
build/assets/js/acecf23e.********.js 193 B 0 B
build/assets/js/b14e0f74.********.js 15.8 kB -27 B (-0.17%)
build/assets/js/b28a5f0c.********.js 21 kB -21 B (-0.1%)
build/assets/js/b4616e61.********.js 18.6 kB -2 B (-0.01%)
build/assets/js/bc6be8dd.********.js 438 B 0 B
build/assets/js/bc7db166.********.js 22.5 kB -23 B (-0.1%)
build/assets/js/c141421f.********.js 172 B 0 B
build/assets/js/c7b90d82.********.js 23.1 kB 0 B
build/assets/js/cf55cfec.********.js 458 B 0 B
build/assets/js/d40a1e80.********.js 9.99 kB -9 B (-0.09%)
build/assets/js/db8d5f16.********.js 11.6 kB -27 B (-0.23%)
build/assets/js/e0719818.********.js 174 B 0 B
build/assets/js/ea82e367.********.js 13.7 kB -21 B (-0.15%)
build/assets/js/eecb7248.********.js 2.94 kB -4 B (-0.14%)
build/assets/js/ef8b811a.********.js 313 B 0 B
build/assets/js/f077d5db.********.js 33.4 kB -8 B (-0.02%)
build/assets/js/f1028ce8.********.js 465 B 0 B
build/assets/js/f13553a8.********.js 436 B 0 B
build/assets/js/f53487f0.********.js 12.6 kB -2 B (-0.02%)
build/assets/js/fd2064b2.********.js 11.5 kB -19 B (-0.17%)
build/blog/authors.html 11.5 kB 0 B
build/community/zunit/zunit-ci.html 42.8 kB +4 B (+0.01%)
build/community/zunit/zunit-running-tests.html 29.8 kB -12 B (-0.04%)
build/docs/category/-getting-started.html 17.9 kB 0 B
build/docs/category/-guides.html 18.9 kB 0 B
build/docs/category/️-syntax.html 20.1 kB 0 B
build/docs/code.html 20.3 kB 0 B
build/docs/guides/syntax/ice-modifiers.html 47.9 kB 0 B
build/ecosystem/annexes/default-ice.html 31 kB -12 B (-0.04%)
build/ecosystem/annexes/linkbin.html 31.6 kB -24 B (-0.08%)
build/ecosystem/annexes/patch-dl.html 27.6 kB -28 B (-0.1%)
build/ecosystem/annexes/submods.html 24.3 kB -20 B (-0.08%)
build/ecosystem/annexes/unscope.html 40.7 kB -16 B (-0.04%)
build/ecosystem/category/-annexes.html 24.3 kB 0 B
build/ecosystem/category/-packages.html 17.3 kB 0 B
build/ecosystem/category/️-plugins.html 28.8 kB 0 B
build/ecosystem/plugins/diff-so-fancy.html 39.5 kB -21 B (-0.05%)
build/ecosystem/plugins/f-sy-h.html 118 kB -8 B (-0.01%)
build/ecosystem/plugins/zbrowse.html 27.5 kB -17 B (-0.06%)
build/ecosystem/plugins/zconvey.html 31.9 kB -1 B (0%)
build/ecosystem/plugins/zprompts.html 29.3 kB -17 B (-0.06%)
build/ecosystem/plugins/zsh-cmd-architect.html 36.7 kB -4 B (-0.01%)
build/ecosystem/plugins/zsh-editing-workbench.html 32.2 kB -17 B (-0.05%)
build/ecosystem/plugins/zsh-select.html 39.7 kB -4 B (-0.01%)
build/ecosystem/plugins/zzcomplete.html 28.9 kB -16 B (-0.06%)
build/index.html 21.5 kB 0 B
build/legal/CODE_OF_CONDUCT.html 20.6 kB 0 B
build/legal/PRIVACY.html 32.7 kB 0 B
build/search.html 16.2 kB 0 B

compressed-size-action

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 78 out of 93 changed files in this pull request and generated 11 comments.

Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (4)

community/00_contributing/01_getting_started.mdx:105

  • This snippet is plain CLI usage. Per the updated docs-authoring guidance, use sh for POSIX shell examples instead of the generic shell fence.
```shell
git rebase -i $(git merge-base HEAD next)
**community/00_contributing/01_getting_started.mdx:129**
* These are portable CLI commands; per the code-block guidance added in this PR, use `sh` (not `shell`) for POSIX shell snippets.
git fetch upstream
git rebase upstream/next  # for feature branches
**community/00_contributing/02_contributing_to_zi.mdx:58**
* This block is Zsh-specific (`zsh` + `source ...`). Per the code-block guidance added in this PR, it should be fenced as `zsh` rather than the generic `shell`.
zsh
source lib/zsh/zi.zsh
**community/00_contributing/02_contributing_to_zi.mdx:70**
* This is ZUnit CLI usage, and the new code-block guidance in this PR explicitly calls out `zunit` for ZUnit CLI examples. Consider changing this fence from `shell` to `zunit` so it receives the intended highlighting.
# Run all tests
zunit

# Run a single test file
zunit tests/install.zunit
</details>

Comment on lines +1 to +4
import type * as PrismNamespace from "prismjs";

export function registerZShellLanguages(Prism: typeof PrismNamespace): void {
Prism.languages.zsh = Prism.languages.extend("bash", {});
Comment on lines +3 to +8
import {registerZShellLanguages} from "../prism/z-shell-languages";
import type * as PrismNamespace from "prismjs";

export default function prismIncludeLanguages(PrismObject: typeof PrismNamespace): void {
(prismIncludeLanguagesOriginal as (p: typeof PrismNamespace) => void)(PrismObject);
registerZShellLanguages(PrismObject);
Comment thread src/css/custom.css
Comment on lines +140 to +147
pre.language-zi .token.zi-command.keyword {
color: var(--site-zi-command-color) !important;
font-weight: 700;
}

pre.language-zi .token.zi-command.function {
color: var(--site-zi-subcommand-color) !important;
}
with:
install-script: pnpm i --frozen-lockfile
build-script: "pnpm build:en"
build-script: "build:en"
Comment thread AGENTS.md
Comment on lines +1 to +10
# Project Guidelines

## Build, Lint, and Dev Commands

- Use Node >= 20 and pnpm >= 10 (see `engines` in `package.json`).
- Install dependencies with `pnpm install`.
- `pnpm start` — local dev server at `http://localhost:3000`.
- `pnpm build` — full production build (run before finishing substantial changes).
- `pnpm build:en` — English-only build, faster for docs-only checks.
- `pnpm serve` — serve the production build locally for verification.
Comment on lines +118 to +120

# Archived/removed z-shell repositories that are referenced in docs for historical context
'https://github\.com/z-shell/zsh-startify',
Comment on lines +36 to +41
```shell
git clone https://github.com/<your-username>/wiki.git
cd wiki
pnpm install # install dependencies
pnpm start # dev server at http://localhost:3000
```
Comment on lines +33 to +40
```shell
# 1. Fork the repo on GitHub, then clone your fork
git clone https://github.com/<your-username>/<repo>.git
cd <repo>

# 2. Add the upstream remote
git remote add upstream https://github.com/z-shell/<repo>.git
```
Comment on lines +45 to +50
```shell
git clone https://github.com/<your-username>/zi.git
cd zi
git remote add upstream https://github.com/z-shell/zi.git
git checkout -b feat/my-change next
```
Comment on lines +169 to +176
```shell
# Single repo
echo "my-repo" > /tmp/repos.txt
./scripts/sync-labels.sh z-shell /tmp/repos.txt

# All org repos
./scripts/sync-labels.sh z-shell scripts/repos.txt
```
@ss-o
Copy link
Copy Markdown
Member Author

ss-o commented May 18, 2026

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI commented May 18, 2026

@copilot apply changes based on the comments in this thread

Applied the remaining valid review fixes in cc43f1a: removed the accidental top-level AGENTS.md, fixed the Prism typing and Zi token selectors, converted the flagged portable shell fences to sh, and corrected the z-shell/zsh-startify heading/lychee cleanup. I also checked the ci-perf failure logs and left build-script: "build:en" unchanged there because the old pnpm build:en form is what broke the compressed-size job.

Copilot finished work on behalf of ss-o May 18, 2026 09:01
ss-o added 12 commits May 19, 2026 07:24
- Create community/00_contributing/ as first-priority section
  - index.mdx: overview with banner SVG + card grid layout
  - 01_getting_started.mdx: org-wide fork/branch/commit/PR guide
  - 02_contributing_to_zi.mdx: zi-specific contributing guide
  - 03_zsh_plugin_standard.mdx: moved from community root (slug preserved)
  - 04_contributing_docs.mdx: wiki MDX authoring and Crowdin guide
  - 05_project_management.mdx: absorbs project tracker + labels content

- Add six SVG illustrations to static/img/svg/community/:
  - contributing-banner.svg: wide workflow diagram (fork→code→PR→merge)
  - contributing-getting-started.svg: git branch tree (120×120)
  - contributing-zi.svg: gear with zi logo (120×120)
  - contributing-plugin-standard.svg: plug/socket icon (120×120)
  - contributing-docs.svg: document with pen (120×120)
  - contributing-project-management.svg: kanban board (120×120)

- Renumber community top-level:
  - 02_zsh_plugin_standard.mdx removed (moved into 00_contributing/)
  - 03_zsh_native_scripting_handbook.mdx → 02_
  - 04_zunit/ → 03_zunit/ (update _category_.json position + doc link)

- Fix ZUnit broken links in index.mdx, 01_installation.mdx, 04_running-tests.mdx
  by adding .mdx extension (forces correct file-based resolution)

- Update community/index.mdx with contributing CTA section

Closes: docs/project-tracker-and-labels branch (content absorbed)
- Expand zsh grammar: adds zsh-builtin (30+ builtins), zsh-expansion-flag,
  zsh-special-parameter, zsh-glob-qualifier alongside existing zi/zunit tokens
- Simplify prism-include-languages.ts to swizzle delegation pattern
- Add comprehensive CSS token palette (9 token types, light + dark themes)
- Fix dead link in zsh_startify.mdx (z-shell/zsh-startify repo is gone)
- Migrate 44 MDX files from shell to zsh/zi/zunit language fences
- ecosystem/plugins/zsh_startify.mdx: remove link to z-shell/zsh-startify (404)
  and remove FontAwesome icon from heading (FA kit removed from wiki)
- community/gallery/collection/06_plugins.mdx: remove hyperlink from
  zsh-startify heading (repo no longer exists)
- community/00_contributing/index.mdx: fix broken CODE_OF_CONDUCT link
  (z-shell/zi repo has no CODE_OF_CONDUCT.md) — use contributor-covenant.org
- community/00_contributing/02_contributing_to_zi.mdx: fix same broken
  CODE_OF_CONDUCT link; remove link to z-shell/community guidelines (repo 404)
- z-shell-languages.ts: rewrite grammar using named capture groups for
  ESLint prefer-named-capture-group compliance; expand zsh-builtin list
  to 50+ builtins; rename zsh-keyword → zsh-builtin; add zsh-expansion-flag
  token; reorganize insertBefore calls for correct priority ordering
- prism-include-languages.ts: replace manual additionalLanguages loop with
  clean swizzle delegation to @theme-original/prism-include-languages
- custom.css: add 9-token semantic color palette (light + dark) for
  zsh-builtin, zsh-expansion-flag, zsh-special-parameter, zsh-glob-qualifier,
  zi-command keyword, zi-command subcommand function, zi-ice, zunit-command,
  zunit-directive, zunit-assertion; uses CSS custom properties and nested rules
- Convert space-separated admonition titles to bracket syntax (MDX v3
  requirement): :::note Title -> :::note[Title] in 4 files
- Add z-shell/zsh-startify to lychee exclude list — repo is archived/removed
  and is referenced in existing docs on the target (next) branch; Trunk
  checks both PR and base versions, causing false CI failures
The action prepends 'pnpm run' to the build-script value, so passing
'pnpm build:en' ran 'pnpm run pnpm build:en' — a non-existent script.
Change to the bare script name 'build:en' so the action runs
'pnpm run build:en' correctly.
…colors

prism-react-renderer applies inline style="color:..." to token spans
using the Dracula/GitHub theme's alias colors, which beats plain CSS rules.
Two fixes:
- Selector: token colors were targeting <code> but Docusaurus puts
  language-* on <pre>; change to pre.language-* selectors.
- Override: add !important to all custom token color declarations so
  they win over the inline styles.

Also migrate z-shell/community membership links to z-shell/.github
(community repo is private; .github has the same 05_membership.yml
template and public issues enabled).
…S nesting

Nested rules inside :is() and block selectors were mangled by the build,
producing invalid CSS like `.language-zsh,...) .token.zsh-builtin` with
the `pre` and `:is(` prefix stripped. Flattened all token color rules to
standard descendant selectors which the pipeline processes correctly.
zi-command: add light-mode, self-update, cdreplay, cdlist, status
zi-ice: add compile, eval, extract, has, if, nocd, sbin, svn (all
  appear in ecosystem/docs pages but were tokenized as plain text)
zunit-command: broaden pattern from strict lookahead to match bare
  zunit and any subcommand/flag, using lookbehind for boundary
Each page now matches the contributing page pattern:
- Full-width 720×140 banner SVG illustrating the section topic
- :::info/:::tip admonition with key links or quick facts
- CSS grid of cards (icon + title + description + arrow link)

Pages updated: docs/, ecosystem/, community/, community/zunit/
SVGs created: docs-banner, ecosystem-banner, community-banner, zunit-banner
All card links verified against actual built URLs.
…ority

prism-react-renderer v2 renders `inside` tokens as compound classes on the
same span, not nested spans — fix CSS to use .token.zi-command.keyword
instead of descendant .token.zi-command .token.keyword.

Move zi-ice insertBefore to fire before zsh-builtin so ice modifiers like
'wait' and 'src' are not mis-tokenized as shell builtins in zi blocks.

Also redesign docs/ecosystem/community/zunit banner SVGs with distinct
color palettes (blue/amber/purple/teal-red) so each section has a unique
visual identity.
@ss-o ss-o force-pushed the feature-syntax-highlighting branch from cc43f1a to 3f2833f Compare May 19, 2026 06:26
Remove ecosystem/plugins/zsh_startify.mdx (was draft: true) and the
corresponding gallery entry in 06_plugins.mdx. The plugin is hosted
under a third-party org that we do not reference in Z-Shell docs.
@ss-o ss-o merged commit 2b64abf into next May 19, 2026
8 checks passed
@ss-o ss-o deleted the feature-syntax-highlighting branch May 19, 2026 06:35
ss-o added a commit that referenced this pull request May 20, 2026
* docs(annexes): update available meta-plugins list

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>

* docs: update Zi paths to XDG base dir defaults and refresh short URLs

- Replace hardcoded ~/.zi paths with ${XDG_DATA_HOME:-$HOME/.local/share}/zi
- Update ZI[HOME_DIR]/ZI[BIN_DIR] defaults in installation and commands guides
- Update ZPFX/polaris references across plugin standard, customization,
  bin-gem-node annex, syntax guide, and zi_console docs
- Replace deprecated git.io short URLs with zshell.dev equivalents

* docs(community): add ZUnit testing framework section

Introduces community/04_zunit/ with eight pages covering installation,
test syntax, assertions, running tests, configuration, and CI integration.

* docs: update raw GitHub URLs from zi-src to source

* fix(docs): correct raw GitHub URLs from zi-src to src

* fix(docs): repair zunit community links (#727)

Co-authored-by: ss-o <ss-o@users.noreply.github.com>

* docs(gallery): fix zsh-eza repository reference

* fix(gallery): replace dead startify reference

* fix(ci): disable stale trunk cache

* fix(docs): update legacy startify references

* feat(docs): add syntax highlighting + restructure community contributing section (#728)

* feat(docs): add z-shell syntax highlighting

* docs(community): restructure contributing section with SVG illustrations

- Create community/00_contributing/ as first-priority section
  - index.mdx: overview with banner SVG + card grid layout
  - 01_getting_started.mdx: org-wide fork/branch/commit/PR guide
  - 02_contributing_to_zi.mdx: zi-specific contributing guide
  - 03_zsh_plugin_standard.mdx: moved from community root (slug preserved)
  - 04_contributing_docs.mdx: wiki MDX authoring and Crowdin guide
  - 05_project_management.mdx: absorbs project tracker + labels content

- Add six SVG illustrations to static/img/svg/community/:
  - contributing-banner.svg: wide workflow diagram (fork→code→PR→merge)
  - contributing-getting-started.svg: git branch tree (120×120)
  - contributing-zi.svg: gear with zi logo (120×120)
  - contributing-plugin-standard.svg: plug/socket icon (120×120)
  - contributing-docs.svg: document with pen (120×120)
  - contributing-project-management.svg: kanban board (120×120)

- Renumber community top-level:
  - 02_zsh_plugin_standard.mdx removed (moved into 00_contributing/)
  - 03_zsh_native_scripting_handbook.mdx → 02_
  - 04_zunit/ → 03_zunit/ (update _category_.json position + doc link)

- Fix ZUnit broken links in index.mdx, 01_installation.mdx, 04_running-tests.mdx
  by adding .mdx extension (forces correct file-based resolution)

- Update community/index.mdx with contributing CTA section

Closes: docs/project-tracker-and-labels branch (content absorbed)

* feat(highlight): unified zsh/zi/zunit prism grammar with token colors

- Expand zsh grammar: adds zsh-builtin (30+ builtins), zsh-expansion-flag,
  zsh-special-parameter, zsh-glob-qualifier alongside existing zi/zunit tokens
- Simplify prism-include-languages.ts to swizzle delegation pattern
- Add comprehensive CSS token palette (9 token types, light + dark themes)
- Fix dead link in zsh_startify.mdx (z-shell/zsh-startify repo is gone)
- Migrate 44 MDX files from shell to zsh/zi/zunit language fences

* fix(docs): remove dead links to non-existent GitHub repositories

- ecosystem/plugins/zsh_startify.mdx: remove link to z-shell/zsh-startify (404)
  and remove FontAwesome icon from heading (FA kit removed from wiki)
- community/gallery/collection/06_plugins.mdx: remove hyperlink from
  zsh-startify heading (repo no longer exists)
- community/00_contributing/index.mdx: fix broken CODE_OF_CONDUCT link
  (z-shell/zi repo has no CODE_OF_CONDUCT.md) — use contributor-covenant.org
- community/00_contributing/02_contributing_to_zi.mdx: fix same broken
  CODE_OF_CONDUCT link; remove link to z-shell/community guidelines (repo 404)

* feat(highlight): implement zsh/zi/zunit prism grammar and token CSS

- z-shell-languages.ts: rewrite grammar using named capture groups for
  ESLint prefer-named-capture-group compliance; expand zsh-builtin list
  to 50+ builtins; rename zsh-keyword → zsh-builtin; add zsh-expansion-flag
  token; reorganize insertBefore calls for correct priority ordering
- prism-include-languages.ts: replace manual additionalLanguages loop with
  clean swizzle delegation to @theme-original/prism-include-languages
- custom.css: add 9-token semantic color palette (light + dark) for
  zsh-builtin, zsh-expansion-flag, zsh-special-parameter, zsh-glob-qualifier,
  zi-command keyword, zi-command subcommand function, zi-ice, zunit-command,
  zunit-directive, zunit-assertion; uses CSS custom properties and nested rules

* fix(docs): fix admonition titles and lychee exclusion

- Convert space-separated admonition titles to bracket syntax (MDX v3
  requirement): :::note Title -> :::note[Title] in 4 files
- Add z-shell/zsh-startify to lychee exclude list — repo is archived/removed
  and is referenced in existing docs on the target (next) branch; Trunk
  checks both PR and base versions, causing false CI failures

* fix(ci): correct build-script for compressed-size-action

The action prepends 'pnpm run' to the build-script value, so passing
'pnpm build:en' ran 'pnpm run pnpm build:en' — a non-existent script.
Change to the bare script name 'build:en' so the action runs
'pnpm run build:en' correctly.

* fix(highlight): correct CSS selector and override inline Prism theme colors

prism-react-renderer applies inline style="color:..." to token spans
using the Dracula/GitHub theme's alias colors, which beats plain CSS rules.
Two fixes:
- Selector: token colors were targeting <code> but Docusaurus puts
  language-* on <pre>; change to pre.language-* selectors.
- Override: add !important to all custom token color declarations so
  they win over the inline styles.

Also migrate z-shell/community membership links to z-shell/.github
(community repo is private; .github has the same 05_membership.yml
template and public issues enabled).

* fix(highlight): flatten CSS selectors — Docusaurus pipeline strips CSS nesting

Nested rules inside :is() and block selectors were mangled by the build,
producing invalid CSS like `.language-zsh,...) .token.zsh-builtin` with
the `pre` and `:is(` prefix stripped. Flattened all token color rules to
standard descendant selectors which the pipeline processes correctly.

* fix(highlight): expand zi/zunit grammar coverage

zi-command: add light-mode, self-update, cdreplay, cdlist, status
zi-ice: add compile, eval, extract, has, if, nocd, sbin, svn (all
  appear in ecosystem/docs pages but were tokenized as plain text)
zunit-command: broaden pattern from strict lookahead to match bare
  zunit and any subcommand/flag, using lookbehind for boundary

* feat(docs): redesign four landing pages with banner SVGs and card grids

Each page now matches the contributing page pattern:
- Full-width 720×140 banner SVG illustrating the section topic
- :::info/:::tip admonition with key links or quick facts
- CSS grid of cards (icon + title + description + arrow link)

Pages updated: docs/, ecosystem/, community/, community/zunit/
SVGs created: docs-banner, ecosystem-banner, community-banner, zunit-banner
All card links verified against actual built URLs.

* fix(highlight): fix zi-command compound selector and zi-ice token priority

prism-react-renderer v2 renders `inside` tokens as compound classes on the
same span, not nested spans — fix CSS to use .token.zi-command.keyword
instead of descendant .token.zi-command .token.keyword.

Move zi-ice insertBefore to fire before zsh-builtin so ice modifiers like
'wait' and 'src' are not mis-tokenized as shell builtins in zi blocks.

Also redesign docs/ecosystem/community/zunit banner SVGs with distinct
color palettes (blue/amber/purple/teal-red) so each section has a unique
visual identity.

* fix(docs): remove zsh-startify — plugin not under z-shell org

Remove ecosystem/plugins/zsh_startify.mdx (was draft: true) and the
corresponding gallery entry in 06_plugins.mdx. The plugin is hosted
under a third-party org that we do not reference in Z-Shell docs.

---------

Co-authored-by: ss-o <ss-o@users.noreply.github.com>

* docs(wiki): address PR 732 review feedback

---------

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
Co-authored-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants