search

erusev / parsedown

Better Markdown Parser in PHP
https://parsedown.org
MIT License
14.74k stars 1.12k forks source link

Missing documentation for $Block #696

Open BenjaminHoegh opened 5 years ago

BenjaminHoegh commented 5 years ago

There should be documentation for the $Block & $Line variabels and $Block['element'] and what the diffrent input are used for, e.g Type or Name

aidantwoods commented 5 years ago

My current plan to resolve this is to formalise a few things like Block, Inline, Line, ... with an interface or dedicated type. WIP over at #685

BenjaminHoegh commented 5 years ago

So you wait to make a wiki page for it to 2.0 are released because of the big changes ?

aidantwoods commented 5 years ago

More or less, now that PR is (hopefully :) ) finalising, I can start writing up some docs around building custom components that can be integrated into the parser (both from the perspective of a writer for components, and someone who consumes them—since there would now be freedom to combine many different things from various sources if desired).