Receber por email
← Voltar para o catálogo

chapter-analyzer

Validates and analyzes Docusaurus MDX chapters for structure, pedagogical quality, and component usage.

367estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add aiskillstore/marketplace

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/chapter-analyzer/svg)](https://www.skillteca.com.br/skills/chapter-analyzer)

Skills relacionadas

Ver todas de Segurança →

Alerta por categoria

Receba novas skills de Segurança toda segunda

1 email curto, só com as skills novas de Segurança. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Chapter Analyzer Logic

Target Directory

  • Location: textbook/docs/
  • Format: MDX (.mdx or .md)

Structural Validation

Every chapter must have valid YAML frontmatter:

---
id: my-chapter-id
title: My Chapter Title
sidebar_label: Sidebar Label
description: Brief summary of the chapter.
---

Content Rules

  1. Heading Hierarchy:
  2. The Docusaurus title acts as H1.
  3. Start content with H2 (##).
  4. Do not use H1 (#) within the body.
  5. Pedagogical Flow:
  6. Introduction: Hook the reader.
  7. Learning Objectives: Bullet points on what will be learned.
  8. Core Content: Explained with text + diagrams/code.
  9. Interactive Element: At least one Quiz or Simulation per major section.
  10. Summary: Recap key points.

Interactive Components

We use custom components in MDX:

  • <Quiz questions={[...]} />: For knowledge checks.
  • <Simulation type="ros2-node" ... />: For embedded simulations.
  • <Tabs> / <TabItem>: For multi-language code blocks (Python/C++).

Tone Check

  • Voice: Encouraging, Authoritative but Accessible.
  • Perspective: "We will learn", "Let's explore".
  • Clarity: Avoid jargon without explanation.
Compartilhar X LinkedIn