writing-docs

von remotion-dev

Richtlinien und Vorlagen zum Schreiben der Remotion-API-Dokumentation im MDX-Format. Erstellen Sie eine .mdx-Datei pro API in packages/docs/docs, fügen Sie sie in sidebars.ts ein und führen Sie bun render-cards.ts aus, um Social-Preview-Karten zu generieren. Verwenden Sie ###-Überschriften für API-Eigenschaften (keine Aufzählungspunkte), fügen Sie ?-Suffix für optionale Parameter hinzu und geben Sie Standardwerte natürlich in den Beschreibungen an. Bevorzugen Sie typsichere Code-Snippets mit twoslash-Validierung; verwenden Sie // ---cut---, um Imports auszublenden, und fügen Sie immer title-Attribute zu...

npx skills add https://github.com/remotion-dev/remotion --skill writing-docs

ZIP herunterladen GitHub

Mehr Skills von remotion-dev

remotion-best-practices

Bewährte Praktiken für Remotion - Videoerstellung in React

Einen neuen Experten zur Remotion-Expertenseite hinzufügen

Ein neues Sound-Effekt zu @remotion/sfx hinzufügen

Füge ein interaktives Demo zur Remotion-Dokumentation hinzu. Verwende dies, wenn du eine neue <Demo>-Komponente für Dokumentationsseiten erstellst.

Behebe einen Dependabot-PR, indem du alle Monorepo-Instanzen der Abhängigkeit aktualisierst, bun install ausführst und pushst.

Automatisiere die Pull-Request-Erstellung mit formatierten Commits und Branch-Verwaltung. Stellt sicher, dass du dich nicht auf dem Hauptbranch befindest, und erstellt bei Bedarf einen Feature-Branch. Führt Oxfmt-Codeformatierung in allen betroffenen Paketen durch, bevor Commits erstellt werden. Formatiert Commits und PR-Titel mit dem Paketnamen aus der package.json (z. B. "@remotion/shapes: Herzform hinzufügen"). Nutzt die gh CLI, um den Pull-Request nach dem Pushen der Änderungen automatisch zu öffnen.

Korrekte Benennung für einen PR

remotion-best-practices

Bewährte Methoden für Remotion - Videoerstellung in React