跳到正文
cccskills
免费在 GitHub 公开

writing-docs-pages

Create and update Handsontable guide pages with consistent page metadata, headings, framework-specific examples, and sidebar entries. Follow the documentation site's writing conventions and generate JavaScript examples from TypeScript sources where required.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Use when creating or editing documentation pages in docs/content/guides/ - covers YAML frontmatter, page structure, framework-specific example embedding, writing style, and sidebar registration

集成工具Excel
查看安装方法

适用场景

  • Adding a guide for a new feature
  • Updating an existing guide's content and metadata
  • Embedding examples for different frameworks
  • Registering a page in the sidebar

包含的文件(1)

  • SKILL.md5.2 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Writing Documentation Pages

1. Frontmatter (required)

---
title: Feature name
metaTitle: Feature name | Handsontable DataGrid for JavaScript
description: Short SEO description under 160 characters.
permalink: /feature-name
canonicalUrl: /feature-name
tags:
  - keyword1
react:
  metaTitle: Feature name | Handsontable DataGrid for React
searchCategory: Guides
category: Cell features    # Must match a sidebar category exactly
menuTag: new | updated     # Optional; sidebar badge
addedIn: "17.0.0"          # Optional; version that introduced the feature
---
  • menuTag: new on a new page, menuTag: updated on a substantive content change. Omit it for typos, snippet/link corrections, and changelog and migration-guide pages; leave an existing tag in place.
  • addedIn: set when the page documents a feature introduced in 14.0.0 or later. Use the full version as a quoted string ("18.1.0", not 18.1), from the changelog's "Added" entry or the option's @since tag. Leave it out for recipes, a new page about an old feature, and a feature that is one section of an older page. npm run build fails on a malformed or never-released version.

2. Page structure

  1. No H1 in the body: Starlight renders the title.
  2. Overview: 1-2 sentences right after the frontmatter.
  3. [[toc]].
  4. ## and below only, basic to advanced: Enable the feature, Basic usage, Configuration options, Advanced usage, Keyboard shortcuts, Known limitations, API reference links.

3. Framework-specific content

::: only-for javascript

JavaScript-only content here.

:::

Put the ::: markers on their own lines, with blank lines around the content. Frameworks: javascript, react, angular, vue.

4. Example embedding

--js 1 --ts 2 sets tab order.

::: only-for javascript

::: example #example1 --js 1 --ts 2
@[code](@/content/guides/category/feature/javascript/example1.js)
@[code](@/content/guides/category/feature/javascript/example1.ts)
:::

:::

::: only-for react

::: example #example1 :react --tsx 1 --jsx 2
@[code](@/content/guides/category/feature/react/example1.tsx)
@[code](@/content/guides/category/feature/react/example1.jsx)
:::

:::

::: only-for vue

::: example #example1 :vue3

@[code](@/content/guides/category/feature/vue/example1.vue)

:::

:::
  • Vue 3: embed a single TypeScript SFC (<script setup lang="ts">) with the :vue3 preset (:vue3-languages or :vue3-vuex for extra dependencies). Skip --html / --js tabs. Full pattern: skill creating-docs-examples.
  • Angular: :angular with --ts 1 --html 2.

5. Writing style

Full voice and words-to-avoid list: docs/AGENTS.md §2.2 (overrides .ai/DOC-STANDARDS.md for the docs site). Page rules:

  • Active voice, American English, short sentences, "you", Oxford comma, no evaluative adjectives ("easy", "simple", "obvious").
  • Separate clauses with hyphens (-) or double hyphens (--). The docs site uses these where JSDoc and changelog use en dashes.
  • Product name: where the page names the product, the first prose mention and the description: say Handsontable DataGrid. Later mentions and generic references keep Handsontable, as do code, package names, API names, migration guides, and version references. The metaTitle: shape is <Page> | Handsontable DataGrid for <Framework>, where <Page> is the page title or a short form of it, with the same casing as title: (keep title: in sentence case), with no dashes. Changelog and migration pages (changelog*, migrating-from-* under guides/upgrade-and-migration/) keep their old metaTitle: shape on purpose; do not rewrite them. Never DataGrid alone as a first mention or in title:, metaTitle:, or a heading (a toggle or tab beside HyperFormula and table labels are the exceptions). Say "data grid" (lowercase) for the category, and drop the noun where the product is already named. Details: .ai/DOC-STANDARDS.md, "Product naming".
  • Bold for UI elements (Add comment), inline code for API names (comments).
  • Internal links: [text](@/path/to/file.md#anchor).
  • End every sentence with a full stop, lists included.

6. Trademark

Pages mentioning "Excel" end with the Microsoft/Excel trademark disclaimer. Pages that also mention "Google Sheets" use the expanded disclaimer for both.

7. Sidebar registration

Add a new page to the right category array in docs/content/guides/sidebar.js:

{ path: 'guides/category/feature-name/feature-name' }

Add onlyFor: ['react'] or onlyFor: ['angular'] for a framework-specific page.

8. Code example generation

Edit the TypeScript source first (.ts or .tsx), then generate JavaScript from docs/ with a path relative to docs/:

cd docs && npm run docs:code-examples:generate-js -- content/recipes/foo/javascript/example1.ts

Vue examples are written directly in the .vue file; no JS variant exists.

Reference

docs/README-EDITING.md: all frontmatter tags, container syntax, content formatting.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Develop and modify the Handsontable Angular wrapper with guidance on component lifecycle, settings updates, and NgZone, which controls change detection. It also covers standalone examples, global configuration, and the build and test workflow.

中文简介正在准备中。当前显示英语简介。

  • Fix settings updates in the Angular wrapper
  • Review change detection around grid operations
  • Update examples to standalone components
handsontable/handsontable2.2万2026年10月19日 更新

Open local or public web pages in BrowserStack Live for checks on real mobile devices or desktop browsers. The skill prepares temporary access to a local server, launches the requested session, and shares its dashboard link.

中文简介正在准备中。当前显示英语简介。

  • Check a local page on an Android device
  • Open a page in Safari on an iPhone or iPad
  • Inspect behavior in a specific desktop browser
handsontable/handsontable2.2万2026年10月19日 更新

Prepare user-facing changelog entries for source code changes. The skill determines whether an entry is needed, classifies the change, writes a clear title, and uses the project CLI to create a JSON file tied to the pull request.

中文简介正在准备中。当前显示英语简介。

  • Add a changelog entry for a bug fix
  • Classify a new feature or behavior change
  • Explain a breaking change and its replacement
handsontable/handsontable2.2万2026年10月19日 更新

Explore relationships between functions and files using a prebuilt code graph, a map of code dependencies. Trace bugs, inspect callers and execution paths, and assess the impact of refactoring or proposed changes.

中文简介正在准备中。当前显示英语简介。

  • Explore callers and dependencies in unfamiliar code
  • Trace a bug across multiple files
  • Assess the impact of renaming or removing code
handsontable/handsontable2.2万2026年10月19日 更新

Work with Handsontable row and column positions by distinguishing source data, displayed order, and rendered cells. It guides index conversion and helps investigate misplaced data when sorting, filtering, hiding, or moving rows and columns.

中文简介正在准备中。当前显示英语简介。

  • Investigating misplaced rows or columns
  • Converting between source and displayed indexes
  • Combining filters with manual column movement
handsontable/handsontable2.2万2026年10月19日 更新

Create Handsontable documentation examples for JavaScript, TypeScript, React, Angular, and Vue. The skill explains source files, generated JavaScript, required imports and license settings, embedding examples in guides, and checking that each framework version displays correctly.

中文简介正在准备中。当前显示英语简介。

  • Adding a code example to a feature guide
  • Preparing examples for multiple frameworks
  • Generating JavaScript examples from TypeScript
handsontable/handsontable2.2万2026年10月19日 更新

查看 handsontable 的全部技能

报告此技能的问题