Ana içeriğe atla

​
Üç adımda başlayın

Dokümantasyon sitenizi yerel olarak çalıştırın ve ilk özelleştirmenizi yapın.

​
Adım 1: Yerel ortamınızı kurun

Kurulum sürecinde, henüz yoksa doküman içeriğinizi barındıran bir GitHub deposu oluşturdunuz. Bu depoya bağlantıyı kontrol panelinizde bulabilirsiniz.Dokümanlarınızda değişiklik yapıp önizlemek için depoyu yerel olarak klonlamak istiyorsanız, GitHub belgelerindeki Bir depoyu klonlama kılavuzunu takip edin.
  1. Mintlify CLI’yi yükleyin: npm i -g mint
  2. Doküman dizininize gidin ve çalıştırın: mint dev
  3. Dokümanlarınızı canlı görmek için http://localhost:3000 adresini açın!
Dosyaları düzenledikçe önizlemeniz otomatik olarak güncellenir.

​
Adım 2: Değişikliklerinizi dağıtın

Kontrol panelinizden Mintlify GitHub uygulamasını yükleyin.GitHub uygulamamız değişikliklerinizi otomatik olarak doküman sitenize dağıtır, böylece dağıtımları kendiniz yönetmeniz gerekmez.
İlk değişiklik olarak doküman sitenizin adını ve renklerini güncelleyelim.
  1. Düzenleyicinizde docs.json dosyasını açın.
  2. "name" alanını proje adınızla değiştirin.
  3. "colors" değerlerini markanıza uyacak şekilde güncelleyin.
  4. Kaydedin ve değişikliklerinizi anında http://localhost:3000 adresinde görün.
Anında bir fark görmek için birincil rengi değiştirmeyi deneyin!

​
Adım 3: Yayına alın

  1. Değişikliklerinizi commit edip push edin.
  2. Dokümanlarınız birkaç dakika içinde güncellenecek ve yayında olacak!

​
Sonraki adımlar

Artık dokümanlarınız çalışıyor, bu temel özellikleri keşfedin:

İçerik yazın

MDX sözdizimini öğrenin ve dokümantasyonunuzu yazmaya başlayın.

Stili özelleştirin

Dokümanlarınızı markanıza mükemmel şekilde uydurun.

Kod örnekleri ekleyin

Sözdizimi vurgulamalı kod blokları ekleyin.

API dokümantasyonu

OpenAPI spesifikasyonlarından otomatik API dokümanları oluşturun.
Yardıma mı ihtiyacınız var? Tam dokümantasyonumuzu inceleyin veya topluluğumuza katılın.