Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move plugins to seperate package? #30

Closed
chrisjsewell opened this issue Aug 12, 2020 · 6 comments · Fixed by #93
Closed

Move plugins to seperate package? #30

chrisjsewell opened this issue Aug 12, 2020 · 6 comments · Fixed by #93

Comments

@chrisjsewell
Copy link
Member

The core can almost be made v1.0.0 now since it won't change much outside porting new versions of markdown-it.
The plugins though can be more changeable, so should probably be moved to a different package, with a different release cadence

Its a bit of a pain though, for maintenance, if both are in different repositories.
But I've never housed to packages in the same repository before, so don't know if thats a good idea 🤷

@choldgraf
Copy link
Member

something like markdown-it-py-extra?

Where do you envision the biggest pain points for maintenance? Are those things we could design automation / documentation / etc around? I have been impressed with the extent to which automating releases has made it relatively easy to have lots of smaller packages rather than one monorepo

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Aug 12, 2020

something like markdown-it-py-extra?

yeh or markdown-it-py-plugins

Where do you envision the biggest pain points for maintenance?

Let's just say its added hassle than I can be bothered with right now lol.
Nothing major TBH; you'd still want all the documentation centralised here, so (a minor thing) you couldn't use sphinx autodoc, maybe some other little things

@choldgraf
Copy link
Member

choldgraf commented Aug 12, 2020

quick thought: I think one benefit of those plugins being separate is that they could be used as examples for how others could extend markdown-it-py w/ their own packages if they wished.

@chrisjsewell
Copy link
Member Author

Oh yeh well they serve as that now, i.e. all folders in https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/extensions are self-contained plugins

@choldgraf
Copy link
Member

yeah - I was just thinking if they were standalone packages then they could be almost like cookiecutters - just copy the package, swap out the bits for your custom extension, and publish on your own

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Aug 13, 2020

Oh they're not each being separate packages though. That would be madness lol; they're only a few 100 lines of code max

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants