writing-docs

tarafından remotion-dev

Remotion API dokümantasyonunu MDX formatında yazmak için yönergeler ve şablonlar. Her API için packages/docs/docs içinde bir .mdx dosyası oluşturun, sidebars.ts dosyasına ekleyin ve sosyal önizleme kartları oluşturmak için bun render-cards.ts komutunu çalıştırın. API özellikleri için ### başlıkları kullanın (madde işaretleri değil), isteğe bağlı parametreler için ? son eki ekleyin ve açıklamalarda varsayılan değerleri doğal bir şekilde belirtin. twoslash doğrulaması ile tip güvenli kod parçacıkları tercih edin; içe aktarmaları gizlemek için // ---cut--- kullanın ve her zaman title niteliklerini ekleyin...