Ana içeriğe atla
Ön koşullar:
  • Node.js sürüm 19 veya üstü
  • docs.json dosyası olan bir doküman deposu
Mintlify’ı işletim sisteminize kurmak ve çalıştırmak için bu adımları izleyin.
1

Mintlify CLI'yi yükleyin

npm i -g mint
2

Yerel olarak önizleyin

docs.json dosyanızın bulunduğu doküman dizininize gidin ve aşağıdaki komutu çalıştırın:
mint dev
Dokümantasyonunuzun yerel bir önizlemesi http://localhost:3000 adresinde kullanılabilir olacaktır.

​
Özel portlar

Varsayılan olarak Mintlify port 3000’i kullanır. Mintlify’ın çalıştığı portu --port bayrağını kullanarak özelleştirebilirsiniz. Örneğin, Mintlify’ı port 3333’te çalıştırmak için bu komutu kullanın: 
mint dev --port 3333
Zaten kullanımda olan bir portta Mintlify’ı çalıştırmaya çalışırsanız, bir sonraki kullanılabilir portu kullanacaktır: 
Port 3000 is already in use. Trying 3001 instead.

​
Mintlify sürümleri

Her CLI sürümünün belirli bir Mintlify sürümüyle ilişkili olduğunu lütfen unutmayın. Yerel önizlemeniz üretim sürümüyle uyuşmuyorsa lütfen CLI’yi güncelleyin: 
npm mint update

​
Bağlantıları doğrulama

CLI, dokümantasyonunuzdaki bağlantıları doğrulamanıza yardımcı olabilir. Kırık bağlantıları belirlemek için aşağıdaki komutu kullanın: 
mint broken-links

​
Dağıtım

Dağıtım başarılı olursa aşağıdakileri görmelisiniz:
Tüm kontrollerin geçtiğini belirten bir dağıtım onay mesajının ekran görüntüsü.

​
Kod biçimlendirme

MDX’i tanımak ve biçimlendirmek için IDE’nizde uzantılar kullanmanızı öneririz. VSCode kullanıcısıysanız, sözdizimi vurgulama için MDX VSCode uzantısını ve kod biçimlendirme için Prettier kullanmayı düşünün.

​
Sorun giderme

Bu, node’un eski bir sürümünden kaynaklanıyor olabilir. Şunları deneyin:
  1. Şu anda yüklü olan CLI sürümünü kaldırın: npm remove -g mint
  2. Node v19 veya üstüne yükseltin.
  3. CLI’yi yeniden yükleyin: npm i -g mint
Çözüm: Cihazınızın kök dizinine gidin ve ~/.mintlify klasörünü silin. Ardından mint dev komutunu tekrar çalıştırın.
En son CLI sürümünde nelerin değiştiğini merak mı ediyorsunuz? CLI değişiklik günlüğüne göz atın.