Mintlify Docs Nedir ve Nasıl Kullanılır: Yeni Başlayanlar İçin Bir Rehber

Şık, kullanıcı dostu ve zahmetli hissettirmeyen belgeler oluşturmakta zorlanıyor musunuz? Blog yazısı yazmak kadar kolay, çarpıcı belgeler oluşturmayı sağlayan, yapay zeka destekli platform Mintlify'ye merhaba deyin. 28K+ GitHub yıldızı ve Stripe gibi müşterileriyle Mintlify, belgelerinizi geliştirmeniz için etkileşimli özellikler, yapay zeka araçları ve sorunsuz entegrasyonlar sunar. Bu başlangıç ​​kılavuzunda, Mintlify'yi yükleme, özel bir alan adı ayarlama, yapay zeka alımından yararlanma, bir MCP sunucusu entegre etme, çeviriler ekleme ve API belgeleri için OpenAPI kullanma konularında size yol göstereceğim. İster bir geliştirici ister bir ekip lideri olun, kısa sürede profesyonel düzeyde belgeler yayınlayacaksınız. Belgelemeyi eğlenceli hale getirmeye hazır mısınız? Hadi başlayalım!

Mintlify Nedir? Belgeleriniz İçin Süper Gücünüz

Mintlify , geliştiricilerin minimum çabayla güzel, etkileşimli ve SEO dostu belgeler oluşturmasına yardımcı olan modern bir dokümantasyon platformudur. Ekipler ve açık kaynak projeleri için oluşturulmuş olup, Markdown ve MDX dosyalarını duyarlı sayfalara dönüştürür, GitHub entegrasyonunu destekler ve kod oluşturma ve çeviriler gibi yapay zeka destekli özellikler sunar. Temel avantajları şunlardır:

• WYSIWYG Editor: Belgeleri tarayıcı tabanlı bir arayüzde düzenleyin.
• Etkileşimli Bileşenler: Sekmeler, kod parçacıkları ve API oyun alanları ekleyin.
• Yapay Zeka Optimizasyonu: Yapay zeka alımı ile aramayı ve erişilebilirliği geliştirin.
• Özelleştirilebilir: docs.json dosyası aracılığıyla temaları, yazı tiplerini ve gezinmeyi ayarlayın.

Sürükle ve bırak iş akışı ve %40 daha yüksek kullanıcı dönüşüm oranlarıyla Mintlify, yeni başlayanlar veya genel projeler için mükemmeldir. Hadi kuralım

Mintlify'yi Yükleme ve Kurma

Mintlify'ye başlamak çok kolaydır ve Node.js, Mintlify CLI ve bir GitHub hesabına ihtiyacınız olacak. İşte işe nasıl başlanacağı, resmi kılavuza göre.

1. Önkoşulları Yükleyin:

• Node.js: https://nodejs.org/ adresinden 16.6 veya daha yüksek bir sürüm indirin. node -v ile doğrulayın.
• GitHub Hesabı: Henüz yoksa github.com adresinden kaydolun.
• VS Code: Düzenleme için isteğe bağlı ancak önerilir. code.visualstudio.com adresinden edinin.

2. Başlangıç ​​Kitini Klonlayın:

• Terminalinizde, Mintlify Başlangıç ​​Kiti'ni klonlayın:

git clone https://github.com/mintlify/starter-kit
cd starter-kit

• Bu, MDX dosyaları içeren bir docs klasörü ve ayarlar için bir docs.json dosyası içeren bir proje oluşturur.

3. Mintlify CLI'yi Yükleyin:

• CLI'yi genel olarak yükleyin:

npm install -g mintlify-cli

• mintlify-cli --version (örneğin, mintlify-cli version 3.1.25) ile doğrulayın.

4. Yerel Önizlemeyi Çalıştırın:

• starter klasöründe, geliştirme sunucusunu başlatın:

mintlify-cli dev

• Bu, http://127.0.0.1:3000 adresinde bir önizleme açar. 3000 numaralı bağlantı noktası meşgulse, 3001'i dener veya özelleştirmek için --port 3333 kullanır (örneğin, mintlify-cli dev --port=3333).

5. Belgelerinizi Düzenleyin:

• Projeyi VS Code'da açın (code .).
• docs/introduction.mdx dosyasına gidin ve "title" alanını "Welcome to My Docs!" olarak değiştirin. Kaydedin ve önizleme anında güncellenir.
• Yazı tiplerini, renkleri değiştirmek veya karanlık modu etkinleştirmek için docs.json dosyasını keşfedin. Örneğin:

{
  "name": "My Docs",
  "theme": "prism",
  "colors": { "primary": "#3498db" }
}

• Simgeler veya logolar gibi genel ayarlar için https://mintlify.com/docs adresini kontrol edin.

Bunu 10 dakikadan kısa sürede kurdum ve değişikliklerimle canlı bir siteye sahiptim; süper sorunsuz!

Mintlify İçin Özel Bir Alan Adı Ayarlama

Belgelerinizin mintlify.app alt alan adı yerine docs.yourcompany.com adresinde olmasını mı istiyorsunuz? Mintlify, özel alan adlarını kolaylaştırır.

1. Ayarlara Erişim:

• mintlify.com adresinden Mintlify Kontrol Panelinize giriş yapın.
• Ayarlar > Özel Alan Adı'na gidin.

2. Alan Adınızı Ekleyin:

• Alan adınızı girin (örneğin, docs.yourcompany.com).
• Sağlayıcınız için DNS talimatlarını izleyin (örneğin, Namecheap, GoDaddy):
• Bir CNAME kaydı ekleyin: docs → cname.vercel-dns.com.
• Cloudflare için "tam katı" HTTPS güvenliğini etkinleştirin.
• Vercel kullanıyorsanız, bir TXT doğrulama kaydı ekleyin (kontrol panelinde gösterilir).

3. Yayılmayı Bekleyin:

• DNS değişiklikleri 48 saate kadar sürer ancak genellikle daha hızlı çözülür. Onaylamak için alan adınızı bir tarayıcıda kontrol edin.

Bir test sitesi için özel bir alan adı ayarladım ve birkaç saat içinde yayına girdi; her açıdan profesyonel hisler!

Mintlify ile Yapay Zeka Alımından Yararlanma

Mintlify'nin yapay zeka alımı, belgelerinizi daha akıllı ve daha erişilebilir hale getirerek, kullanıcıların yapay zeka destekli sorgular aracılığıyla içerik aramasına olanak tanır.

1. Yapay Zeka Alımını Etkinleştirin:

• Mintlify Kontrol Panelinde, Ürünler > Yapay Zeka Sohbeti'ne gidin.
• Yapay zeka alımını açın. Bu, belgelerinizi ek kurulum yapmadan yapay zeka araması için indeksler.
• Mintlify, LLM'lerin içeriğinizi verimli bir şekilde indekslemesi için otomatik olarak bir /llms.txt site haritası oluşturur.

2. Yapay Zeka Aramasını Test Edin:

• Canlı belgelerinizde, arama çubuğunu veya Yapay Zeka Sohbeti'ni (docs.json aracılığıyla etkinleştirilmişse) kullanın.
• Şunu sorun: "API ile nasıl kimlik doğrulaması yaparım?" Yapay zeka, kimlik doğrulama sayfanız gibi ilgili bölümleri çeker.

3. Yapay Zeka Düzeltmeleriyle Geliştirin:

• Web düzenleyicide, yapay zeka MDX hataları için sözdizimi düzeltmeleri önerir (örneğin, hatalı biçimlendirilmiş bileşenler). Bunu Ayarlar > Düzenleyici'de etkinleştirin.

Yapay zeka aramasını bir örnek sitede denedim ve API belgelerimi anında buldu; manuel aramadan çok daha hızlı!

Mintlify ile Bir MCP Sunucusu Entegre Etme

Model Context Protocol (MCP), yapay zeka uygulamalarının belgeleriniz veya API'lerinizle etkileşim kurmasını sağlar. Mintlify, içeriğinizi LLM'lerle bağlamak için bir MCP sunucusu oluşturur.

1. MCP CLI'yi Yükleyin:

• Şunu çalıştırın:

npm i @mintlify/mcp

• Mintlify Kontrol Panelinde, benzersiz yükleme komutunuzu almak için Ürünler > MCP Sunucusu'na gidin.

2. MCP Sunucusunu Yapılandırın:

• Harici Yönetici Anahtarınızı ve Sohbet API Anahtarınızı Ayarlar > API Anahtarları'nda bulun.
• İstendiğinde anahtarları girerek, kontrol panelinden CLI komutunu çalıştırın.
• API uç noktalarını dahil etmek için OpenAPI Erişimi'ni açın (bir OpenAPI spesifikasyonu gerektirir).

3. MCP Sunucusunu Kullanın:

• CLI, sunucunuzu başlatmak için bir komut çıkarır (örneğin, npm --prefix ~/.mcp/mintlify start).
• Windsurf gibi bir MCP istemcisiyle test edin ve şunu sorgulayın: "API kimlik doğrulaması için belgelerimi arayın." Sunucu yapılandırılmış sonuçlar döndürür.

Mintlify MCP Sunucusunu Yerel Olarak Yükleme

Mintlify MCP sunucusunu makinenizde çalıştırmak için:

• Şunu çalıştırın:

npx @mintlify/mcp add mintlify

• Enter tuşuna basarak taşıyıcı belirteci istemini atlayın.
• Yerel olarak yüklü olan MCP istemcinizi (örneğin, Claude Desktop, Windsurf) seçin.
• Sunucu, seçtiğiniz istemci için yüklenir ve yapılandırılır.

Örnek: Windsurf kullandım ve terminal bana şunu verdi:

node C:\User\Me.mcp\mintlify\src\index.js

• Bu komutu çalıştırın, istemcinizdeki araçlar simgesine tıklayın ve sunucunun kullanılabilir olduğunu doğrulayın.
• Alternatif olarak, Mintlify Kontrol Panelinde, sunucuyu MCP istemcinize (örneğin, Apple DB) eklemek için bir komut bulmak için MCP Sunucusu'na gidin.

Örnek İstek (Windsurf'te):

Bu PRD'ye dayalı olarak, AppleDB belgelerinin tarzında ve tonunda bu özellik hakkında bir yardım belgesi yazın.

Veya, Mintlify uyumlu biçim için:

Bunu, çıpalar gibi Mintlify bileşenlerini kullanarak markdown olarak yazın.

• mcp istemcinizden (örneğin windsurf veya claude desktop) çıktıyı kopyalayın, Mintlify'nin web düzenleyicisine yapıştırın, görsel moda geçin ve önizleyin!

Bir MCP sunucusu kurdum ve yapay zeka asistanımın belgelerimi bir profesyonel gibi sorgulamasına izin verdi; fütüristik şeyler!

Mintlify Belgelerine Çeviriler Ekleme

Belgelerinizin birden fazla dilde olmasını mı istiyorsunuz? Mintlify'nin yapay zeka destekli çevirileri, yerelleştirmeyi anında gerçekleştirir.

1. Çevirileri Etkinleştirin:

• Mintlify Kontrol Panelinde, Ayarlar > Çeviriler'e gidin.
• Bir yerel ayar ekleyin (örneğin, İspanyolca için es) ve çevrilecek bir sürüm seçin.
• Mintlify, belgelerinizi otomatik olarak çevirir, güncellemeleri ana sürümle senkronize eder.

2. Çevirileri Özelleştirin:

• Deponuzun yerel klasöründeki (örneğin, docs/es/) çevrilmiş MDX dosyalarını düzenleyin.
• "Bu sayfa faydalı mıydı?" gibi sabit içerik, yerel ayara otomatik olarak uyum sağlar.

3. Çeviriyi Test Edin:

• Canlı belgelerinizde, sürüm açılır menüsü aracılığıyla (docs.json içinde yapılandırılmış) yerel ayarları değiştirin.

• Başlıkların ve içeriğin hedef dili yansıttığını kontrol edin (örneğin, İspanyolca için "¡Bienvenidos!").

İspanyolca çeviriler ekledim ve belgelerim dakikalar içinde küresel kullanıma hazırdı; erişilebilirlik için büyük bir kazanç!

Mintlify'yi VS Code ile Kullanma

VS Code'da kod belgeliyor musunuz? Mintlify'nin uzantısı bunu anında gerçekleştirir!

1. Mintlify Uzantısını Yükleyin:

• VS Code'un Uzantı Pazarı'nı açın.
• "Mintlify" için arama yapın ve Yükle'ye tıklayın.

2. Belge Oluşturun:

• Belgelendirmek istediğiniz kodu vurgulayın.
• Kenar çubuğundaki Mintlify simgesine tıklayın ve Belge Oluştur'u seçin veya Ctrl + . kısayolunu kullanın.
• Mintlify, belgeleri otomatik olarak yazar.

Örnek Kod:

test("@e2e wait for api response", async ({ page }) => {
  const sidemenuPage = new SideMenuPage(page);
  await sidemenuPage.interceptApiLink.click();
  const response = await page.waitForResponse((response) =>
    response.url().includes("/comments")
  );
  expect(response.status()).toBe(200);
  await page.getByText("CREATE post").isVisible();
});

Oluşturulan Belgeler:

Kod bloğu, API yanıtının başarıyla alınıp alınmadığını kontrol eden bir test durumudur.

Bir test betiği belgeledim ve Mintlify açıklamayı yaptı; zahmetsiz!

Mintlify'nin Özelliklerini Keşfetme

Mintlify, belgelerinizi parlatmak için araçlarla doludur. İşte nasıl seviye atlayacağınız:

• Web Düzenleyici: Kontrol Paneli > Düzenleyici aracılığıyla tarayıcıda belgeleri düzenleyin. Sekmeler veya çağrı kutuları gibi bileşenler için / yazın.
• Temalar ve Stil: docs.json içinde renkleri, yazı tiplerini veya logoları özelleştirin. prism veya default gibi temaları deneyin.
• GitHub Entegrasyonu: Değişiklikleri otomatik olarak dağıtmak için Mintlify GitHub Uygulamasını yükleyin. Kurulum için kontrol panelini kontrol edin.
• Analizler: Popüler sayfaları veya terkleri görmek için Kontrol Paneli > Analizler'de kullanıcı etkileşimini izleyin.
• Bileşenler: MDX aracılığıyla akordeonlar, kod grupları veya Mermaid diyagramları ekleyin. Örnekler için https://mintlify.com/docs adresine bakın.

Temamı değiştirdim ve sekmeler ekledim, belgelerimin bir saatten kısa sürede profesyonel bir tasarım gibi görünmesini sağladım!

Özet: Mintlify Yolculuğunuz Başlıyor

Harika iş; çarpıcı, yapay zeka hazır belgeler oluşturmak için Mintlify'nin gücünü açtınız! CLI'yi yüklemekten özel alan adları, yapay zeka alımı, MCP sunucuları, çeviriler ve OpenAPI oyun alanları ayarlamaya kadar, kullanıcıları etkileyecek belgeler oluşturmaya hazırsınız. Yeni bileşenlerle deneyler yapın, daha fazla dil ekleyin veya API'lerinizi APIdog ile belgeleyin! İyi belgeleme!