react-notion-x
react-notion-x copied to clipboard
docs: add typedocs
trafficstars
📝 TypeDoc Documentation
- adds documentations automatically generated from TypeDoc
- adds script
yarn docsto 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], addedyarn docsscript/packages/*/package.json: addedtypedocMainproperty to indicate the entrypoint for TypeDoctsconfig.json: added configuration for TypeDoc (entrypoints, output location, documentation title, etc)/docs: contains the generated documentation in markdown formatreadme.md: added docs links along with packages, added notion-compat package details (missing description)
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) |
Sure! I will add commits without the docs folder.
Any progress on the PR? I'd love to see some improvements on the docs and provide some help if needed 👍