Belgeleri Kullanarak Markdown Dosyaları ile Belge Oluşturma
Ücretsiz bir eklenti, çerçeve veya açık kaynaklı bir komut dosyası oluşturuyorsanız dokümantasyona ihtiyacınız olacak. İçin çok önemli çalışmanızı belgeleyin, hem akıl sağlığınız hem de mükemmel kaynağınızı öğrenmek isteyen başkalarına yardım etmek için.
Ancak, çevrimiçi dokümantasyon oluşturmak gerçek bir acı olabilir. Neyse ki, Docsify sağlayarak kolaylaştırır Markdown üzerinde çalışan ücretsiz dökümantasyon jeneratörü.
Bu tipik bir statik site üreteci değil ve yapar statik HTML / CSS sayfaları gerektirmez. Onun yerine Markdown dosyalarını yükler dinamik ve onları web sayfası olarak görüntüler. Oldukça temiz!
İçin Dokümanlar ana sayfasına göz atın. düzenin önizlemesi, ile birlikte daha fazla kurulum detayı.
Seni gerektiriyor index.html dosyasını kendiniz oluşturun, daha sonra GitHub Sayfalarına yüklenebilir veya kendi sunucunuzda barındırılabilir. Oradan, sadece sen Her sayfa için Markdown dosyalarını yaz ve bunları birincil dokümanlarınız olarak kullanın.
Tüm süreç, hızlı başlangıç Kılavuzu, Bu yüzden muhtemelen başlamak için en iyi yer. Bu olabilir hepsi npm'den geçiyor, bu yüzden komut isteminizi bilmek gerçekten yardımcı olur veya en azından öğrenmeye istekli.
Ham bir HTML dosyası kendiniz oluşturmak ve şablonu Docsify'ın kurulum kılavuzundan kopyalayıp yapıştırmak mümkündür. Ama öneririm bunu dinamik olarak yapmak, çünkü zamandan tasarruf ediyor - ve bu gerçekten önemli değil?
Docsify sistemini öğrenirken, Markdown veya ham HTML kullanarak özellikler ekleyin. Bu özellikler arasında özel gezinti çubuğu ve hatta kendi kapak sayfan projenizin logolu.
Dokümanlar bile bir sürü ücretsiz tema ile paketlenmiş olarak geliyor önceden tasarlanmış düzenleri çalışmak istiyorsanız. Veya, yapabilirsiniz onların vitrin galerisine göz atın hangi projelerin dokümantasyonunda Docsify kullandığını görmek için.
Hepsi temel kurulum bilgisi ve dosya indirmeleri GitHub’da bulunabilir, o yüzden şut atmak istiyorsanız oraya gidin.
Ayrıca ana Dokümantasyon dokümantasyon sayfasında canlı bir demo izleyin Tabii ki, yeterince, Docsify üzerinde çalışır. Dolayısıyla, bu web sayfası düzenini seviyorsanız, aynı şablonu kullanabilir ve% 100 ücretsiz ve açık kaynak kodlu Docsify üzerinden çalıştırabilirsiniz..
