Skip to content
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.

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

The README.md document needs to be updated. #150

Open
Scoheart opened this issue Oct 14, 2024 · 0 comments
Open

The README.md document needs to be updated. #150

Scoheart opened this issue Oct 14, 2024 · 0 comments

Comments

@Scoheart
Copy link

Now, some contents in the README.md of Parchment are no longer correct.
For example, this part of the code in the README.md, is no longer usable now.

import { InlineBlot, register } from 'parchment'
class LinkBlot extends InlineBlot { ... }
register(LinkBlot)

When I checked the source code or the TypeScript declaration file, I knew that a new way of usage was needed.
It should be used like this.

import { InlineBlot, Registry } from 'parchment'
class LinkBlot extends InlineBlot { ... }
const registry = new Registry()
registry.register(LinkBlot)

When will the README.md be updated, or will there be a new document of Parchment to be released?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant