skills.rest
danicat
danicatCOMMUNITY
Explore all skills by this author →
Website𝕏@danicat83GitHub

google-codelab-authoring

Create Google Codelabs in `.lab.md` format with required structure and metadata.

13|3|Updated Jan 29, 2026
Search Tags:#documentation#markdown#validation#readability#authoring#inclusive language#codelab
One-click install
npx skills add https://github.com/danicat/skills --skill google-codelab-authoring
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: google-codelab-authoring
Source: https://github.com/danicat/skills/tree/main/google-codelab-authoring
Command: npx skills add https://github.com/danicat/skills --skill google-codelab-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Producing a Google Codelab that meets required structure and metadata rules is time-consuming and error-prone, especially when formatting or accessibility details are easy to miss.

Core Features & Use Cases

  • Enforces codelab formatting standards: Guides you to follow the required .lab.md structure, headings, step conventions, and Duration: MM:SS placement.
  • Validates structure and quality: Requires running deterministic validators (scripts/validate_codelab.cjs) and a readability check (scripts/fog.cjs) before finalizing.
  • Promotes inclusive, audience-appropriate writing: Pushes inclusive language and avoids jargon by referencing included style references.
  • Provides an end-to-end workflow: From planning and initializing with the template (assets/template.lab.md) to writing, reviewing, and validating.

Quick Start

Use the google-codelab-authoring skill to validate that your .lab.md file follows the required Google Codelab metadata, structure, and readability rules by running the included validators on your codelab draft.

Frequently Asked Questions about google-codelab-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate my Google Codelab markdown before publishing?▼

To validate your Google Codelab markdown before publishing, run the included deterministic validator and readability scripts against your `.lab.md` draft to check structure, metadata, and compliance.

What is the required file format and metadata structure for a Google Codelab?▼

The required format for a Google Codelab is a `.lab.md` markdown file containing specific metadata, step headings, and a `Duration: MM:SS` field to pass structural validation.

How do I write inclusive and accessible documentation for Google Codelabs?▼

To write inclusive and accessible documentation for Google Codelabs, follow the provided style references to push inclusive language, avoid jargon, and ensure audience-appropriate readability.

Can I use a template to initialize a new Google Codelab?▼

Yes, you can initialize a new Google Codelab using the provided `assets/template.lab.md` file, which establishes the correct foundational structure for your end-to-end authoring workflow.

Why did my Google Codelab fail the readability check during validation?▼

Your Google Codelab failed the readability check because the text did not pass the FOG index threshold enforced by the `scripts/fog.cjs` script, indicating complex or jargon-heavy writing.

Related Skills

Explore More Content & Communication Skills→
BaoNguyen09BaoNguyen09
6

install-mac

Install Node.js and project dependencies on macOS for development.

Community
Intermediate
mgkyawzayyamgkyawzayya
1

documentation-management

Detect documentation drift and update project docs and README.

Community
Intermediate
deandumdeandum
3

style

Enforce language-agnostic coding style and conventions across a codebase.

Community
Intermediate
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic