search

gbv / cocoda-sdk

SDK for Cocoda and coli-conc services
https://gbv.github.io/cocoda-sdk/
MIT License
5 stars 1 forks source link

Fix documentation via JSDoc #36

Closed stefandesu closed 1 year ago

stefandesu commented 2 years ago

The documentation under https://gbv.github.io/cocoda-sdk/ broke with the code restructuring to make cocoda-sdk an ES module. This needs to be fixed.

stefandesu commented 2 years ago

Apparently this is an issue with default class exports in ES6 (export default class) which hasn't been fixed in 6 years. I added a plugin with a workaround to fix it. However, there's still something wonky as I get duplicate class members in the docs now.

I also changed JSDoc so that we can build the documentation locally. Unfortunately, npm now shows security issues since our template better-docs hasn't been updated in a while and is apparently no longer maintained. Might be worth looking for an alternative.