Skip to main content
Gereksinimler:
  • Node.js sürüm 19 veya üzeri
  • docs.json dosyası içeren bir dokümantasyon repository’si
İşletim sisteminizde Mintlify’ı kurmak ve çalıştırmak için bu adımları izleyin.
1

Mintlify CLI'ı Kurun

npm i -g mint
Mintlify CLI’ı global olarak yükleyin. Bu araç, dokümantasyonunuzu yerel ortamda önizlemenizi sağlar.
2

Yerel Önizleme Başlatın

docs.json dosyasının bulunduğu docs dizinine gidin ve aşağıdaki komutu çalıştırın:
cd docs
mint dev
Dokümantasyonunuzun yerel önizlemesi http://localhost:3000 adresinde kullanılabilir olacaktır.

​
Özel Port Kullanımı

Varsayılan olarak Mintlify 3000 portunu kullanır. --port bayrağını kullanarak Mintlify’ın çalışacağı portu özelleştirebilirsiniz. Örneğin, Mintlify’ı 3333 portunda çalıştırmak için: 
mint dev --port 3333
Halihazırda kullanımda olan bir portta Mintlify’ı çalıştırmaya çalışırsanız, bir sonraki kullanılabilir portu kullanacaktır: 
Port 3000 zaten kullanımda. Bunun yerine 3001 deneniyor.

​
Mintlify Sürümleri

Her CLI sürümünün belirli bir Mintlify sürümüyle ilişkili olduğunu unutmayın. Yerel önizlemeniz production sürümüyle uyuşmuyorsa, lütfen CLI’ı güncelleyin: 
mint update
CLI, dokümantasyonunuzdaki linkleri doğrulamada yardımcı olabilir. Kırık linkleri tespit etmek için aşağıdaki komutu kullanın: 
mint broken-links
Bu komut, dokümantasyonunuzdaki tüm linkleri tarar ve çalışmayan linkleri size bildirir.

​
Dağıtım (Deployment)

Dağıtım başarılı olduğunda aşağıdakine benzer bir onay mesajı görmelisiniz:
Tüm kontrollerin başarıyla tamamlandığını gösteren dağıtım onay mesajı ekran görüntüsü

​
Kod Formatlama

IDE’nizde MDX’i tanımak ve formatlamak için eklentiler kullanmanızı öneririz. VSCode kullanıcısıysanız, sözdizimi vurgulama için MDX VSCode eklentisi’ni ve kod formatlama için Prettier’ı göz önünde bulundurun.

​
Sorun Giderme

Bu, eski bir node 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 üzerine yükseltin
  3. CLI’ı 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.
Eğer 3000 portu kullanımdaysa, ya başka bir port belirtin:
mint dev --port 3333
Ya da 3000 portunu kullanan uygulamayı kapatın.

​
Fonify.co Projesi için Geliştirme

Fonify.co web sitesi Next.js ile geliştirilmiştir. Web sitesini yerel ortamda çalıştırmak için: 
# Ana proje dizininde
npm install
npm run dev
Web sitesi http://localhost:3000 adresinde çalışacaktır. Dokümantasyon için docs/ dizininde çalışın.

​
Değişiklik Güncellemeleri

En son CLI sürümünde nelerin değiştiğini merak ediyor musunuz? CLI değişiklik günlüğü’ne göz atın.