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

[Feature Request]: Add Plugin Method for Adding Custom Conversions to the Pipeline #22

Open
4 of 9 tasks
revdavethompson opened this issue May 23, 2023 · 0 comments
Open
4 of 9 tasks
Labels
enhancement 👍 New feature or request

Comments

@revdavethompson
Copy link
Collaborator

revdavethompson commented May 23, 2023

Preflight Checklist

Problem Description

There is currently no means by which a user can add their own custom conversion methods. In order to add functionality, they need to edit the BookPub source code itself.

Users need a way to add the conversions they need to fit their own publishing needs.

Proposed Solution

Add a folder "plugins" in the root of new bookpub projects where users can add their own cusotm conversion functions.

Plugins modules should include:

  • a variable for the manuscript content
  • a variable for options
  • a convention for adding plugin options in the book.config.yml file

Alternatives Considered

Initially considered adding remark-directives and creating a folder called directives in the user's book project root. But it seemed a better option not to limit users to directives and unified only. They should be able to add any functionality they want, even if it is something outside the unified ecosystem.

Additional Information

No response

Can you help?

  • I would like to help with this feature

What aspects can you help with?

  • Manuscript Source/Design
  • Documentation
  • Emotional Support 😏
  • Node/Javascript Development
  • Testing

Contact Info 📧

No response

@revdavethompson revdavethompson added the enhancement 👍 New feature or request label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 👍 New feature or request
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant