Comments (4)
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.
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.
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.
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)
- Document extra_flags plugin api changes after next version release
- Adjust data field width description to clarify what's possible.
- Better documentation of LEKTOR_DEPLOY_KEY
- Json-ld schemas HOT 2
- BUG: Project.discover() not set when Lektor loaded with --project ARG HOT 4
- Broken link in the Lektor documentation.
- Deploying using GitHub actions
- BUG: Installing on windows fails. --prefer-binary option for the venv pip is not recognized. HOT 5
- The Travis CI build failed for Lektor website HOT 1
- error: invalid command 'bdist_wheel' HOT 4
- Deployment to public website is broken (invalid credentials in the repo secrets) HOT 20
- Get plugin pages to update more regularly HOT 2
- Atom plugin page is out of date HOT 1
- Add guides for the official plugins
- Mention example / reference projects
- Add dedicated page for LEKTOR_DEV
- We should probably build the webpack-generated resources as part of our deployment workflow
- New custom types which use "single-line" input widgets should inherit from SingleInputType rather than Type
- Download button should reference stable release HOT 3
- Header Links and Table of Contents don't build with mistune 2.x
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 lektor-website.