Publish API documentation as a web page

strvcom / atlas.js

A component-based Node.js library to reduce boilerplate and provide sane project structure 🍻

BSD 3-Clause "New" or "Revised" License

106 stars 9 forks source link

Publish API documentation as a web page #73

Open robertrossmann opened 5 years ago

robertrossmann commented 5 years ago

Having publicly accessible API documentation could help developers discover features of Atlas and generally help navigating the landscape. Now that we have TS typings we could use TypeDoc. Preliminary research suggests this will work quite well at least for the main Atlas package:

npx typedoc --mode modules --out docs --exclude "**/node_modules/**" --includeDeclarations --excludeExternals packages/atlas