Comments (11)
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.
Related Issues (20)
- Paste options for plain text content
- Inline Embed not working in 2.0 branch
- Is this condition of `uiNode` a typo? HOT 2
- registering a new blot does not add it to the allowed children of the scroll object
- block
- How cloud I understand Scope and What is the meaning of & operator between Scope and another Scope
- How to set editor content with html style
- Make v2 the default branch HOT 1
- register Blot unsucessfully
- [Question] Is it possible to define how a blot is serialized ? HOT 1
- How to add custom inline blot (or any blot whatsoever)? HOT 2
- Where can I find the old version commit? HOT 1
- Incorrect descendant typing (ts2769) HOT 1
- Adding a custom Blot HOT 1
- Remove Byte Order Mark (BOM) characters from Blot HOT 3
- Quill editor removes inline style margin-left on loading content
- the img tag is not closed HOT 1
- re-export classes from quill-delta and parchment
- How do we replicate the functionality inside a blot's `replace` function?
- Support ClassAttributor if prefix == ''
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from parchment.