Skills Guide

Livre Docusaurus

VérifiéSûr

Créez, structurez et déployez un site Docusaurus pour le manuel Physical AI. Cette compétence est utile pour initialiser le site de documentation du manuel, ajouter des chapitres, configurer la barre latérale ou déployer sur GitHub Pages ou Vercel. Elle impose également une structure de contenu adaptée au RAG avec des métadonnées et des titres sémantiques.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
02/06/2026
Claude CodeCursorWindsurf
#docusaurus#documentation-site#textbook#rag-ready

Recommandé pour

Claude CodeCursorDocumentation automatiqueWindsurf

Synthèse automatique

Ce skill permet de créer, structurer et déployer un site Docusaurus pour un manuel de Physical AI, avec un contenu adapté à la consultation et à l'exportation pour RAG.

Points forts

  • Structure modulaire et hiérarchique adaptée aux cours
  • Intégration de la recherche locale et DocSearch
  • Export RAG prêt avec métadonnées et titres sémantiques
  • Déploiement automatisé sur GitHub Pages ou Vercel

Limites

  • Nécessite Node.js et une connaissance de base de Docusaurus
  • Les composants MDX personnalisés doivent être créés séparément
  • La configuration de DocSearch nécessite une clé Algolia externe
Quand l'utiliser

Utilisez ce skill lorsque vous devez mettre en place un site de documentation pour un manuel technique structuré en modules, semaines et chapitres, avec une exportation facile pour des systèmes RAG.

Quand l'éviter

Ne l'utilisez pas pour un simple site vitrine ou un blog sans structure hiérarchique complexe, ni si vous avez besoin d'un CMS avec édition en ligne.

Analyse de sécurité

Sûr
Score qualité93/100

The skill instructs setting up a Docusaurus documentation site using standard tools (npx, npm) and writing content. There are no destructive commands, no exfiltration, and no obfuscation. All actions are typical of project scaffolding and deployment.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Scaffold and deploy a Physical AI textbook site
Set up a Docusaurus site for my Physical AI textbook with modules 1-4, a capstone, and a quarter overview. Configure sidebar, add MDX components for callouts and hardware tables, enable search, and set up GitHub Actions deployment to GitHub Pages.
Add a new chapter with RAG-ready metadata
Create a new chapter for module 2 week 3 on sensor fusion. Write an MDX file with frontmatter including title, description, module=2, week=3, and tags. Follow the semantic heading structure (h2 for weeks, h3 for sections).
Export all content for RAG ingestion
List all markdown files under docs/ excluding build/ and static/. Output a glob pattern to feed into a RAG ingestion pipeline. Ensure each file has frontmatter fields title, description, module, week, tags.

name: book-docusaurus description: Scaffold, structure, and deploy the Physical AI textbook in Docusaurus with book-aware content and RAG-ready exports. Use when creating or updating the Docusaurus site, adding chapters, configuring sidebar, or deploying to GitHub Pages/Vercel.

Book Docusaurus Skill

Instructions

  1. Scaffold the site

    • Ensure Node >=18 is installed
    • Run npx create-docusaurus@latest physical-ai-book classic in project root or /docs
    • Configure docusaurus.config.js with site metadata, GitHub Pages URLs, i18n (en default)

  2. Structure content

    • Build sidebars.js for Quarter overview, Modules 1-4, Capstone, Assessments, Hardware kits, Cloud option
    • Create MDX stubs per module/week with learning outcomes and tasks
    • Add capstone outline

  3. Authoring affordances

    • Add MDX components for callouts, checklists, hardware tables, code blocks
    • Enable search (Algolia DocSearch placeholder) and local search plugin for dev

  4. Deploy

    • Add GitHub Actions workflow for GH Pages (npm ci, npm run build, npm run deploy)
    • Document Vercel deploy steps (import repo, build command npm run build, output build)

  5. RAG-readiness

    • Enforce frontmatter fields: title, description, module, week, tags
    • Keep headings semantic (h2 for weeks, h3 for sections)
    • Avoid heavy client-side rendering for core text
    • Export ingestion guidance: markdown path glob, ignore build/static

Examples

# Create new chapter
mkdir -p docs/module-1/week-1
cat > docs/module-1/week-1/intro.mdx << 'EOF'
---
title: Introduction to Physical AI
description: Overview of embodied intelligence and humanoid robotics
module: 1
week: 1
tags: [physical-ai, robotics, introduction]
---

# Introduction to Physical AI

Content here...
EOF

# Build and test locally
npm run build
npm run serve

Definition of Done

  • npm run build passes; site renders outline and sample content
  • Sidebar matches course hierarchy; links valid
  • GH Pages workflow present; deploy instructions written
  • Content annotated with frontmatter and semantic headings suitable for chunking

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/book-docusaurus-mmlj2otu/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/book-docusaurus-mmlj2otu' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/book-docusaurus-mmlj2otu/download' --output '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md.part' && mv '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md.part' '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md' && test -s '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/book-docusaurus' && cp -R '.skill-downloads/book-docusaurus-mmlj2otu' '.claude/skills/book-docusaurus'

Cursor
test -f '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md' && test -s '.skill-downloads/book-docusaurus-mmlj2otu/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/book-docusaurus' && cp -R '.skill-downloads/book-docusaurus-mmlj2otu' '.cursor/skills/book-docusaurus'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/book-docusaurus-mmlj2otu'

openskills read 'book-docusaurus-mmlj2otu'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/book-docusaurus-mmlj2otu/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot