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

Making Plugins (mermaid, datatables) Default #2529

Open
Tim-Siu opened this issue Apr 24, 2024 · 0 comments
Open

Making Plugins (mermaid, datatables) Default #2529

Tim-Siu opened this issue Apr 24, 2024 · 0 comments

Comments

@Tim-Siu
Copy link
Contributor

Tim-Siu commented Apr 24, 2024

Please confirm that you have searched existing issues in the repo

Yes, I have searched the existing issues

Any related issues?

No response

What is the area that this feature belongs to?

Performance, Plugins

Is your feature request related to a problem? Please describe.

Currently, the mermaid and datatables plugins are not activated by default. The arguments are that the performance overhead brought in is not negligible:

  1. For the mermaid plugin (Add Mermaid Plugin #2475), the external javascript loaded from CDN comes in at 3.3MB and is kind of heavy. It may result in some network costs.
  2. For the dataTable plugin (Add dataTable plugin #2446), the javascript involved is much lighter. The performance overhead, however, is not thoroughly investigated.

However, such a configuration is contradictory to our wishes that 'everything works out of the box'. This issue is the umbrella issue to call for investigation on the performance overhead of the plugins and efforts to make the plugins default.

Describe the solution you'd like

It is suggested by Prof. Damith that we can load the javascript libraries on demand. This is possible with modifications to the backend (site build) code.

Describe alternatives you've considered

No response

Additional context

No response

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

No branches or pull requests

2 participants