Dökümantasyon dosyaları her zaman lokalden deploy edilmemeli. Kurallı bir gist dökümantasyonu linke edilerek site kontentine gönderilebilsin. Bu bir örnek dosya

readme.md

_

Dizin Yapısı

Bu dizin altında çeşitli uzantıların şablonlarını bulabilirsiniz. Mesela tex formatının templeytleri buradadır. Yer alan formatlar,

• css: Site içeriklerinin stil şablonları
• erb: Birtakım ruby kodlarının gömülü olduğu şablonlar
• js: JavaScript içerikleri
• pics: Site içi buketler (resimler)
• tex: tex-live (latex) şablonları

Öntanımlılar

İsim	Öntanımlı
css	default.css, locale.css, tex.css
erb	conf.erb, default.erb
js	default.js
tex	rules.tex, contributors.tex

Dizin Ağacı

 "_"
|
|___ css
|   |___ default.css: Ana içerik stil şablonu
|   |___ locale.css: Yapılandırılmış içerik stil şablonu
|   |___ tex.css: Tex içeriklerinin olası stil şablonu
|
|___ erb
|   |___ conf.erb: config dosyasının gömülü ruby şablonu
|   |___ default.erb: Folyoların gömülü ruby şablonu
|
|___ js
|   |___ default.js: Folyoların ek JavaScript dosyası
|
|___ tex
|   |___ rules.tex: Genel kuralların tex dosyası
|   |___ contributors.tex: Katkıcı listesinin tex dosyası
|
 Rakefile: tex uzantılı dosyaları html'e çeviren bir converter

İçeriklerle İlgili Notlar

• css içerisindeki stil şablonları sadece geliştirici tarafından değiştirilmelidir.
• Keza erb dizini içerisindeki şablonlarda sadece geliştirici tarafından değiştirilmelidir.
• js içerisindeki JavaScript dosyaları geliştirilmeye açıktır.
• pics dizini içerisindeki her bir içerik MIT lisansına sahiptir.
• tex dizini içerisindeki rules.tex ve contributors.tex dosyaları sadece geliştirici tarafından değiştirilebilir.
• Aksi bir tex geliştirmesinde bulunulan dizindeki (current d.) Rakefile dosyası çalıştırılmalıdır.
• Bu dizinde oluşmuş veya oluşacak olan pipo2fo.conf isimli config dosyası pipo2fo programı içerisinde optimize edilmelidir.

=== Dökümanize eden: Hüseyin Tekinaslan <[email protected]>