README.tr.md

^{EN  |  DE  |  中文  |  ES  |  日本語  |  FR  |  RU  |  TR}

İnsanlar ve makineler için dokümantasyon.
Tek bir Markdown kaynağı → web sitesi, arama, yapay zeka bağlamı, ajanlar ve bilgi formatları.

Web Sitesi  ·  Belgeler  ·  Cloud Relay  ·  Canlı Düzenleyici  ·  Ajan Becerileri  ·  Sorun Bildir

Hızlı Başlangıç

docmd'yi bir Markdown dosyaları klasörüne yönlendirin:

npx @docmd/core dev

http://localhost:3000 adresini açın.

Bu kadar. Gezinme menüsü dosya yapınızdan otomatik oluşturulur. Yapılandırma dosyası, frontmatter veya harici bir çatı gerektirmez.

Dağıtıma hazır olduğunuzda:

npx @docmd/core build

docmd; Vercel, Cloudflare Pages, Netlify, GitHub Pages, S3, NGINX, Caddy veya herhangi bir statik sunucuya dağıtılabilecek statik bir site oluşturur.

Node.js 20+ gerektirir.

Küresel yükleme ve Docker

Genel (global) olarak yükleyin:

npm install -g @docmd/core

# veya
pnpm add -g @docmd/core

Ardından:

docmd dev
docmd build

Veya Docker ile çalıştırın:

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest

Tekrarlanabilir üretim derlemeleri için Docker imajını belirli bir sürüme sabitleyin.

Tek Kaynak. Her Çıktı.

docmd açık kaynaklı bir dokümantasyon derleyicisidir.

docmd, Markdown içeriğinizi yalnızca bir web sitesi girdisi olarak görmek yerine, aynı kaynaktan okuyucular, arama motorları, LLM'ler, kodlama ajanları ve bilgi sistemleri için çıktılar derler.

Markdown
   │
   ▼
 docmd
   │
   ├── → Statik dokümantasyon sitesi
   ├── → Çevrimdışı arama dizini
   ├── → llms.txt / llms-full.txt
   ├── → Açık Bilgi Formatı (OKF)
   ├── → Site haritası + SEO meta verileri
   ├── → robots.txt + Open Graph
   ├── → Yapay zeka ajanları için MCP arayüzü
   └── → Yapay Zeka Asistanı bağlamı

Tek bir kaynak ağacı. Tek bir derleme hattı. Ayrı ayrı dokümantasyon ve yapay zeka bilgi yığınları yönetmeye gerek yok.

Neden docmd?

Dokümantasyonun artık birden fazla okuyucusu var.

İnsanlar hızlı, gezilebilir bir web sitesine ihtiyaç duyar. Arama motorları yapılandırılmış meta verilere ihtiyaç duyar. LLM'ler temiz bağlama ihtiyaç duyar. Kodlama ajanları araçlara ve protokollere ihtiyaç duyar. RAG sistemleri yapılandırılmış bilgiye ihtiyaç duyar.

docmd, Markdown'ı merkezde tutarak tüm bunları bir arada oluşturur.

Docusaurus, Mintlify ve diğer dokümantasyon araçlarıyla eksiksiz karşılaştırmayı görün →

Özellikler

Sıfır yapılandırma, anında başlangıç

docmd'yi herhangi bir Markdown klasörüne yönlendirin ve hemen çalışsın. Gezinme, dosya yapınızdan otomatik olarak oluşturulur — başlamak için ortak kod kalıplarına, frontmatter'a veya derleme süreçlerine gerek yoktur.

Varsayılan olarak hafif, her yerde hızlı

docmd, minimum saf JavaScript ve hızlı SPA tarzı gezinme ile statik HTML üretir. Çevrimdışı tam metin arama, site haritası, kurallı URL'ler (canonical), Open Graph meta verileri ve diğer temel özellikler çıktının içinde yerleşik olarak bulunur.

Yapay Zeka ve Ajanlara Hazır

docmd, makine tarafından okunabilir dokümantasyonu ayrı bir yayınlama iş akışı olarak değil, derlemenin doğal bir parçası olarak ele alır.

• Yapay Zeka Asistanı — Belgelerinize dayanan RAG destekli sohbet
• MCP Sunucusu — Uyumlu kodlama ajanlarının belgelerinizi aramasına, okumasına ve doğrulamasına olanak tanır
• llms.txt / llms-full.txt — LLM tarafından okunabilir eksiksiz dokümantasyon bağlamı
• Açık Bilgi Formatı (OKF) — Yapay zeka ve RAG sistemleri için yapılandırılmış bilgi paketleri
• Ajan Becerileri (Agent Skills) — LLM'ler ve kodlama ajanları için yeniden kullanılabilir talimatlar
• Markdown Olarak Kopyala / Bağlamı Kopyala — Doğrudan tarayıcıdan temiz bağlam çıkarma
• Semantik Arama — Yerleşik anahtar kelime aramasının yanında isteğe bağlı vektör tabanlı arama

Büyümek için Tasarlandı

• Yerel arama ve otomatik çıktılarla yerelleştirme (i18n)
• Birden çok dokümantasyon sürümü desteği (sürümleme)
• Monorepo'lar ve çok projeli yapılar için Çalışma Alanları (Workspaces)
• API dokümantasyonu için OpenAPI 3.x oluşturucu
• Yerleşik temalar, özel CSS/JavaScript ve açık/koyu mod

Yapay Zeka Asistanı ve Cloud Relay

docmd, dokümantasyonunuza dayanan RAG destekli bir Yapay Zeka Asistanı içerir.

Bunu kendi arka ucunuza veya yerel yapay zeka sağlayıcınıza bağlayabilirsiniz. Dokümantasyonunuz statik bir site olarak dağıtılmışsa, docmd Cloud Relay barındırılan güvenli köprüyü sağlar.

Dokümantasyonunuz
        │
        ▼
 @docmd/plugin-ai
        │
        ▼
 docmd Cloud Relay
        │
        ▼
Yapay zeka sağlayıcınız

Cloud Relay, sağlayıcı kimlik bilgilerinin tarayıcıya gönderilmesine gerek kalmadan ve bir yapay zeka arka ucu işletmenize gerek kalmadan, yapay zeka isteklerini seçtiğiniz sağlayıcıya güvenli bir şekilde iletir.

Cloud Relay, kendi yapay zeka sağlayıcı anahtarınızla ücretsiz olarak kullanılabilir.

• Kendi sağlayıcınızı ve modelinizi getirin (BYOK)
• Sağlayıcı kimlik bilgilerini istemciden uzakta tutun
• Statik barındırma ile uyumludur
• Dağıtılacak veya sürdürülecek yapay zeka arka ucu yoktur
• Kullanım görünürlüğü ve okuyucu sorularına dair içgörüler
• Tek bir hesaptan birden fazla dokümantasyon projesi bağlayın

Cloud Relay Kurulumu → • Yapay Zeka Asistanı belgeleri →

Cloud Relay kullanımı ücretsizdir. Model kullanım ücretleri, seçtiğiniz yapay zeka sağlayıcısı tarafından ayrıca faturalandırılabilir.

Komut Satırı Arayüzü (CLI)

docmd dev            # Yerel geliştirme sunucusunu başlatır
docmd build          # Üretim için derleme yapar
docmd live           # Tarayıcı tabanlı Canlı Düzenleyiciyi başlatır
docmd init           # Bir yapılandırma dosyası oluşturur
docmd doctor         # Yapılandırma ve eklenti durumunu denetler
docmd validate       # Dahili dokümantasyon bağlantılarını doğrular
docmd migrate        # Docusaurus, VitePress, MkDocs veya Starlight'tan geçiş yapar
docmd deploy         # Dağıtım yapılandırmasını oluşturur
docmd mcp            # stdio üzerinden MCP sunucusunu çalıştırır
docmd add <name>     # Bir eklenti veya tema yükler
docmd stop           # Çalışan docmd geliştirme sunucularını durdurur

Tüm CLI Komutlarını Görün →

Eklentiler

docmd bir eklenti sistemi üzerine inşa edilmiştir. Yaygın dokümantasyon özellikleri çekirdekle birlikte gelirken, isteğe bağlı eklentiler ihtiyaç duyulduğunda kurulabilir.

Eklenti	Durum	Açıklama
ai	Çekirdek	BYOK, yerel sağlayıcılar ve Cloud Relay ile RAG Yapay Zeka Asistanı
search	Çekirdek	İsteğe bağlı anlamsal arama ile çevrimdışı anahtar kelime araması
seo	Çekirdek	SEO ve Open Graph meta verileri
sitemap	Çekirdek	sitemap.xml oluşturur
git	Çekirdek	Git geçmişi ve son güncelleme meta verileri
analytics	Çekirdek	Hafif analitik entegrasyonu
llms	Çekirdek	llms.txt ve llms-full.txt dosyalarını oluşturur
okf	Çekirdek	Açık Bilgi Formatı (OKF) paketleri
mermaid	Çekirdek	Mermaid diyagram oluşturma
openapi	Çekirdek	OpenAPI 3.x dokümantasyon oluşturucu
pwa	İsteğe bağlı	Progresif Web Uygulaması ve çevrimdışı gezinme
threads	İsteğe bağlı	Satır içi dokümantasyon tartışmaları (geliştiren: @svallory)
math	İsteğe bağlı	KaTeX / LaTeX formül desteği

İsteğe bağlı bir eklenti yükleyin:

docmd add <eklenti-adi>

Kendinizinkini geliştirin: Eklenti Geliştirme Kılavuzu →

Yapılandırma

Yapılandırma isteğe bağlıdır.

Daha fazla kontrole ihtiyaç duyduğunuzda proje kök dizinine docmd.config.json, docmd.config.ts veya docmd.config.js ekleyin:

{
  "title": "Projem",
  "url": "https://docs.projem.com",
  "src": "./docs",
  "out": "./dist"
}

Dinamik değerler gerektiğinde TypeScript ve JavaScript yapılandırmaları kullanılabilir.

Yapılandırma referansı →

Programatik API

docmd'yi Node.js betiklerinizden, CI/CD süreçlerinizden veya özel derleme sistemlerinizden kullanabilirsiniz.

import { build } from '@docmd/core';

// Dokümantasyonu programatik olarak derleyin.
await build('./docmd.config.json', { isDev: false });

CommonJS ve ESM desteklenir.

Node API referansı →

Geçiş (Migration)

Mevcut dokümantasyonunuza sıfırdan başlamanıza gerek yoktur.

docmd migrate

Docusaurus, VitePress, MkDocs ve Starlight dahil olmak üzere desteklenen çerçeveler için geçiş araçları mevcuttur.

Geçiş belgeleri →

Açık Kaynak

Dokümantasyonunuz, projenizin entelektüel kalbidir. Git deponuzda düz Markdown dosyalarında yer almalıdır — taşınabilir, sürüm kontrollü ve denetlenebilir.

docmd derleyicisi ve resmi çekirdek eklentileri MIT lisanslıdır ve hiçbir zaman ücretli özellik duvarı barındırmayacaktır.

Oluşturulan dokümantasyon herhangi bir yerde barındırılabilir ve docmd tarafından barındırılan bir altyapı gerektirmez.

Topluluk

• Belgeler → docs.docmd.io
• Sorular ve Fikirler → GitHub Discussions
• Hatalar ve Özellik İstekleri → GitHub Issues
• Katkıda Bulunma → CONTRIBUTING.md
• Yol Haritası → GitHub Discussions

docmd'yi Destekleyin

docmd sizin için yararlı olduysa:

• Depoya bir ⭐ verin
• Dokümantasyon geliştiren biriyle paylaşın
• Sorun bildirin, düzeltmeler gönderin veya bir eklenti oluşturun
• GitHub'da geliştirmeyi destekleyin

Lisans

MIT Lisansı. Ayrıntılar için LICENSE dosyasına bakın.