react-notion-x icon indicating copy to clipboard operation
react-notion-x copied to clipboard

docs: add typedocs

Open ntcho opened this issue 3 years ago • 3 comments
trafficstars

📝 TypeDoc Documentation

  • adds documentations automatically generated from TypeDoc
  • adds script yarn docs to generate documentations
  • adds docs links to readme.md

DEMO: You can preview the docs at my branch here: https://github.com/ntcho/react-notion-x/tree/docs/docs

Fixes #238

Summary of files changed

  • package.json, yarn.lock: added [email protected] and [email protected], added yarn docs script
  • /packages/*/package.json: added typedocMain property to indicate the entrypoint for TypeDoc
  • tsconfig.json: added configuration for TypeDoc (entrypoints, output location, documentation title, etc)
  • /docs: contains the generated documentation in markdown format
  • readme.md: added docs links along with packages, added notion-compat package details (missing description)

ntcho avatar Apr 17 '22 02:04 ntcho

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
react-notion-x ✅ Ready (Inspect) Visit Preview Apr 17, 2022 at 2:38AM (UTC)
react-notion-x-minimal-demo ✅ Ready (Inspect) Visit Preview Apr 17, 2022 at 2:38AM (UTC)

vercel[bot] avatar Apr 17 '22 02:04 vercel[bot]

Sure! I will add commits without the docs folder.

ntcho avatar Apr 20 '22 13:04 ntcho

Any progress on the PR? I'd love to see some improvements on the docs and provide some help if needed 👍

9oelM avatar Jun 13 '22 04:06 9oelM