Expand documentation about parchment HOT 11 CLOSED

I'm happy to ignore the code comments and keep them for my own personal knowledge of the project. I've created my first of a series of blog posts on parchment and posted it here:

https://dev.to/charrondev/getting-to-know-quilljs---part-1-parchment-blots-and-lifecycle--3e76

I'd appreciate any feedback you have.

from parchment.

I can't claim this is all accurate, but I've got my own fork here JSDoc comments on most of the code. I'm probably going to trim some of them down, now that I have a bit better of an understanding, and make a PR but you can take a look here: https://github.com/vanilla/parchment

from parchment.

As I mentioned in #46 I think it is most helpful if you start with a guide or blog post. If there are elements that I feel is helpful to Quill/Parchment we will go from there. Code comments are highly subjective and I will not debate the topic in Github.

from parchment.

I'm thinking it would be a bit of an easier read of it could be broken up into sections and cross-linked (and not need the long introductory "What is Quill and why am I writing this article" part at the top.)

from parchment.

Just wanted to say that this effort is much appreciated, @charrondev! Just reading through your branch with the function comments helped me through the custom blot I'm working on for my project.

from parchment.

There's actually 3 "embed" blots:

• Parchment's EmbedBlot
  • Don't use this one.
• Quill's Embed
  • This is an "inline" embed. It's contents are padded by invisible whitespace characters that are used to detect modification of the contents and allow you to react. Here's an example of our mention embed blot.
• Quill's BlockEmbed
  • This is for embeds that are like a line of their own.
  • On top of the base parchment blot it supports attributors and descendant children, and has some special handling in quill.
  • Here's an example of our error blot.

from parchment.

This would be super helpful for me, as I'm just getting started and some of these more advanced things are not touched at all in the documentation and the code itself is mostly void of documentation.

from parchment.

@jhchen are you interested in putting parchment docs into the quilljs repo, or this one? I think there is much value to this and would like to know what you would like to see happen.

from parchment.

I have feeling the Quill repo might be the right place. Most of the core blots are extended in a significant way from Quill. I would likely not find myself building on Parchment's Embed directly. I'd much rather build off of Quill's BlockEmbed or Embed.

from parchment.

@charrondev what's the difference betwee Quill's Emebed and Parchmnet's Embed?

from parchment.

Closing inactive issue.

from parchment.