Git Product home page Git Product logo

Comments (4)

rlaverde avatar rlaverde commented on June 29, 2024

Looking to the comments of the doc page, @mitsuhiko says that the markdown engine is terrible and because of that It isn't documented https://www.getlektor.com/docs/api/plugins/events/#comment-2534271280

What should be improved? or the markdown engine is better now and It's ok to document it?

from lektor-website.

nixjdm avatar nixjdm commented on June 29, 2024

Ah, I didn't see that. I simply noticed that the markdown events weren't listed. We could mark them as unstable, but still include some docs for them as they are now, while noting that they are subject to change (though realistically I don't think it be terribly soon at this point). I'm not aware of any issues to drastically change the markdown event hooks, but if we mark it as unstable, we can just update the docs again if / when we do rewrite it.

@mitsuhiko What do you think? Do you have anything in mind to replace the markdown engine with, or some specific problems you could make an issue about, or is one already made I haven't found?

from lektor-website.

rlaverde avatar rlaverde commented on June 29, 2024

Maybe @mitsuhiko is refering to this https://github.com/lektor/lektor/blob/master/lektor/markdown.py#L71-L73

"These markdown parsers are all terrible. Not one of them does not modify internal state."

I'm not aware of any issues to drastically change the markdown event hooks

Yes, even a rewrite of the markdown logic could preserve the signals logic, maybe the problems will be if plugins assume other things of the markdown logic (like the structure of the renderer).

from lektor-website.

nixjdm avatar nixjdm commented on June 29, 2024

We're going to go ahead and add these event hooks to the docs, and just mark that they may break in the future if we swap out mistune or really change how we're using it..

from lektor-website.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.