adev-writing-guide by angular/angular
npx skills add https://github.com/angular/angular --skill adev-writing-guide本技能为在 adev/src/content 中编写内容提供了全面的指导方针。它结合了 Google 的技术写作标准与 Angular 特定的 Markdown 约定、组件和最佳实践。
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
CONTRIBUTING.md 或类似文件中存在)。为语法高亮使用适当的语言标识符:
angular-ts。angular-html。ts。html。shell 或 bash。mermaid。您可以在语言标识符后使用花括号 {} 中的属性来增强代码块:
header="标题":为代码块添加标题。linenums:启用行号。highlight="[1, 3-5]":高亮显示特定行。hideCopy:隐藏复制按钮。prefer:将代码标记为首选示例(绿色边框/勾选)。avoid:将代码标记为应避免的示例(红色边框/叉号)。示例:
```angular-ts {header:"我的组件", linenums, highlight="[2]"}
@Component({
selector: 'my-app',
template: '<h1>你好</h1>',
})
export class App {}
```
<docs-code> 组件对于更高级的代码块功能,请使用 <docs-code> 组件:
path:源文件的路径(例如,adev/src/content/examples/...)。header:自定义标题文本。language:语言标识符(例如,angular-ts)。linenums:布尔属性。highlight:行号/范围数组(例如,[[3,7], 9])。diff:差异文件的路径。visibleLines:初始显示的行范围(可折叠)。region:要从源文件中提取的区域。preview:布尔值。渲染实时预览(StackBlitz)。仅适用于独立示例。hideCode:布尔值。默认折叠代码。多文件示例:
<docs-code-multifile path="..." preview>
<docs-code path="..." />
<docs-code path="..." />
</docs-code-multifile>
使用特定关键词后跟冒号来创建提示。这些内容会渲染为带样式的块。
NOTE: 用于辅助信息。TIP: 用于有用的提示或快捷方式。IMPORTANT: 用于关键信息。CRITICAL: 用于关于潜在数据丢失或严重问题的警告。TODO:用于不完整的文档。QUESTION: 向读者提出问题。SUMMARY: 用于章节摘要。TLDR: 用于简洁的摘要。HELPFUL: 用于最佳实践。示例:
TIP: 使用 `ng serve` 在本地运行您的应用程序。
<docs-card>):
<docs-card-container> 内。title, link, href。<docs-callout>):
title, important, critical。<docs-pill>):
<docs-pill-row> 内。title, href。<docs-step>):
<docs-workflow> 内。title。<docs-tab>):
<docs-tab-group> 内。label。<docs-video>):
src(YouTube 嵌入 URL),alt。使用标准的 Markdown 语法,并可选择性地使用属性来控制大小和加载行为。
#small, #medium:附加到图片 URL 以调整大小。{loading: 'lazy'}:添加属性以实现延迟加载。示例:

#, ##, ###)。h2 和 h3 最常用于内容结构。每周安装次数
67
仓库
GitHub 星标数
100.2K
首次出现
2026年2月18日
安全审计
安装于
github-copilot65
gemini-cli65
opencode64
amp64
codex64
kimi-cli64
This skill provides comprehensive guidelines for authoring content in adev/src/content. It combines Google's technical writing standards with Angular-specific markdown conventions, components, and best practices.
CONTRIBUTING.md or similar).Use the appropriate language identifier for syntax highlighting:
angular-ts when TypeScript code examples contain inline templates.angular-html for Angular templates.ts for plain TypeScript.html for plain HTML.shell or bash.mermaid.You can enhance code blocks with attributes in curly braces {} after the language identifier:
header="Title": Adds a title to the code block.linenums: Enables line numbering.highlight="[1, 3-5]": Highlights specific lines.hideCopy: Hides the copy button.prefer: Marks code as a preferred example (green border/check).avoid: Marks code as an example to avoid (red border/cross).Example:
```angular-ts {header:"My Component", linenums, highlight="[2]"}
@Component({
selector: 'my-app',
template: '<h1>Hello</h1>',
})
export class App {}
```
<docs-code> ComponentFor more advanced code block features, use the <docs-code> component:
path: Path to a source file (e.g., adev/src/content/examples/...).header: Custom header text.language: Language identifier (e.g., angular-ts).linenums: Boolean attribute.highlight: Array of line numbers/ranges (e.g., [[3,7], 9]).diff: Path to diff file.visibleLines: Range of lines to show initially (collapsible).Multifile Example:
<docs-code-multifile path="..." preview>
<docs-code path="..." />
<docs-code path="..." />
</docs-code-multifile>
Use specific keywords followed by a colon for alerts. These render as styled blocks.
NOTE: For ancillary information.TIP: For helpful hints or shortcuts.IMPORTANT: For crucial information.CRITICAL: For warnings about potential data loss or severe issues.TODO: For incomplete documentation.QUESTION: To pose a question to the reader.SUMMARY: For section summaries.TLDR: For concise summaries.HELPFUL: For best practices.Example:
TIP: Use `ng serve` to run your application locally.
<docs-card>):
<docs-card-container>.title, link, href.<docs-callout>):
title, important, critical.<docs-pill>):
Use standard markdown syntax with optional attributes for sizing and loading behavior.
#small, #medium: Append to image URL for sizing.{loading: 'lazy'}: Add attribute for lazy loading.Example:

#, ##, ###).h2 and h3 are most common for content structure.Weekly Installs
67
Repository
GitHub Stars
100.2K
First Seen
Feb 18, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
github-copilot65
gemini-cli65
opencode64
amp64
codex64
kimi-cli64
Claude技能创建器指南:构建模块化AI技能包,优化工作流与工具集成
5,700 周安装
region: Region to extract from source file.preview: Boolean. Renders a live preview (StackBlitz). Only works with standalone examples.hideCode: Boolean. Collapses code by default.<docs-pill-row>.title, href.<docs-step>):
<docs-workflow>.title.<docs-tab>):
<docs-tab-group>.label.<docs-video>):
src (YouTube embed URL), alt.