New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing React API docs #46

Open

michaelboyles opened this issue Dec 4, 2024 · 1 comment

michaelboyles commented Dec 4, 2024

The Readme for the React integration links to https://milkdown.dev/docs/api/react but there is no such page.

In fact, any gibberish slug e.g. https://milkdown.dev/docs/api/fsajgsa will simply render /docs/api

So two suggestions:

Unknown slugs should 404. It would at least be clearer that it's a dead link
Add docs for React API (useEditor, MilkdownProvider, etc.) or at least remove the link from the readme

Member

Saul-Mirone commented Dec 9, 2024

The correct link is https://milkdown.dev/docs/recipes/react. Will update soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment