Otomatik API belgelerini arıyor wiki çözümü, jsdoc

Question

İç wiki'ye otomatik bir şekilde dahil etmek istediğimiz jsdoc sözdizimi ile belgelenen büyük JS kodu parçamız var.

Buna göre, kod tabanımızdan jsdoc ile otomatik sayfa oluşturabilen wiki çözümünü arıyorum.

Herhangi bir fikrin var mı?

Answer 1

JSDoc'un yerleşik özelliğini kaynağından oluşturmak ve kendi şablonunuzu buna uygulamak için kullanabilirsiniz. Daha sonra WIKI'nizden sadece oluşturduğu HTML sayfalarına bağlantı veriyorsunuz. Bunu her seferinde JSDoc'un sayfa jeneratörü çalıştırmak için cron'u kullanarak otomatikleştirebilir ve wiki'nizden aynen görünmesini sağlamak için şablonlama işlevini kullanabilirsiniz. Bu bizim yaptığımız şey. valid-jsdoc: Uygulama kodu eslint kullanarak geçerli ve tam bir jsdoc varsa

Answer 2

1. Önce çek tavsiye ederiz. Geçerli bir jsdoc itibaren
oluşturulabilir:
• lodash (jsdoc
• gelen Markdown şablonları gibi seçeneklerle
• Daha karmaşık bir Docdash üretir basit bir araçtır docdown, varsayılan şablon jeneratör kullanın. com gibi), ihracat yapılandırması, vb. Tam bir html oluşturur.