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

[11/08/2024]: Enhance JSQuarto with Plugin Support for Custom Documentation Extraction and Output Formatting #196

Open
RealRichi3 opened this issue Aug 11, 2024 · 0 comments
Labels
question Further information is requested

Comments

@RealRichi3
Copy link
Member

Description:

To make JSQuarto more flexible and adaptable to various project needs, I propose enhancing the tool by adding plugin support. This would allow users to extend and customize JSQuarto in two key areas:

  1. Documentation Extraction:

    • Users should be able to add plugins that modify how documentation is extracted from source files. This could include custom parsers for different code styles or additional languages, and even advanced features like annotation-based extraction.
  2. Output Formatting:

    • Users should have the ability to specify how the extracted documentation is presented. Plugins could enable custom themes, templates, or output formats (e.g., markdown, HTML, PDF). This would allow for tailored documentation outputs that meet specific project requirements.

Goals:

  • Modular Architecture: Design JSQuarto to support a modular plugin architecture, allowing for easy integration of community-driven plugins.
  • Customization: Ensure that both extraction and output formatting can be customized independently or in combination.
  • User-Friendly API: Provide a simple API for plugin developers to interact with the core functionality of JSQuarto.
@RealRichi3 RealRichi3 added the question Further information is requested label Aug 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant