parchment icon indicating copy to clipboard operation
parchment copied to clipboard

The README.md document needs to be updated.

Open Scoheart opened this issue 4 months ago • 0 comments

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?

Scoheart avatar Oct 14 '24 08:10 Scoheart