Yazılım oluştururken en önemli görevlerden biri dokümantasyondur, maalesef bu çalışmayı geliştirenler için bazen sıkıcı görünebilir, ancak iyi dokümantasyonun herhangi bir aracın başarı noktası olabileceği hiç kimse için bir sır değildir, çünkü Ya için Kullanıcılara uygulamanın doğru çalıştığını anlamaları için verilen yardım veya onu iyileştirmek için diğer geliştiricilere sağlanan bilgiler.
Projelerimizi basit bir şekilde belgelememize izin veren oldukça iyi uygulamalar var, bazıları gerçekten istediğimizden fazlasını sunma eğilimindeyken, diğerleri karmaşık kurulumlar gerektiriyor. projeleri belgelemek için araç bu uyumlu ve kullanımı ve kurulumu oldukça basit olan Docusaurus'tur.
Docusaurus nedir?
Belgeler için bir proje açık kaynak araçları derleyin, uygulayın ve koruyun web belgeleridili kullanmaya izin verir Markdown Daha sonra bir html web sitesi olarak yayınlanacak dokümantasyonu yazmak için, aynı şekilde, araç dokümantasyon web sitemizin tasarımını React kullanımıyla genişletmemize ve özelleştirmemize olanak tanır.
Genel olarak, Facebook programlama ekibi tarafından geliştirilen bu açık kaynaklı araç, herhangi bir projenin belgelerini düzgün bir şekilde görüntüleyebileceğimiz güzel ve hafif web sitelerini kolayca oluşturmamızı sağlar.
Araç, belgelerin doğru versiyonlanması, gelişmiş bir arama motoru, dokümantasyon sitemizi gerçek zamanlı olarak dokümantasyon ve yeniden tasarlama imkanı, çevirilerle entegrasyon ve dokümantasyon hakkında daha az endişelenmenize yardımcı olacak diğer birçok özellik ile donatılmıştır. dokümantasyon süreci daha kolay ve daha hoş bir sonuçla.
Docusaurus'un kolay kullanımı, geliştiricileri tarafından dağıtılan aşağıdaki gifte görülebilir.
Docusaurus nasıl kurulur?
Docusaurus'un ana hedefi, github'da barındırılan açık kaynaklı uygulamaları belgelemek için kesin bir araç olmaktır, bu nedenle dokümantasyon web sitenizi bu platformda kurmak ve çalıştırmak gerçekten çok kolaydır.
Github'da Docusaurus'un keyfini çıkarmaya başlamak için, geliştirme ekibi tarafından belirtilen ve aşağıda alıntı yaptığımız adımları izleyin:
- Belgeleri oluşturacağınız ve aşağıdaki komutları çalıştıracağınız GitHub depo dizininizin köküne gidin:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Sonuç, aşağıda gösterildiği gibi bir dosya ve dizin yapısının oluşturulması olacaktır:
Denemek için ilginç bir hata!