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

[WIP] Major 5 manifest #519

Open
13 tasks
3y3 opened this issue Sep 20, 2024 · 4 comments
Open
13 tasks

[WIP] Major 5 manifest #519

3y3 opened this issue Sep 20, 2024 · 4 comments

Comments

@3y3
Copy link
Member

3y3 commented Sep 20, 2024

Improve plugins functionality

  • Implement async transform API (3y3)
  • Add deprecation warning for sync transform API (3y3)

Reduce package build size

  • Extract liquid to @diplodoc/md-liquid package (3y3)
  • Add deprecation warning for liquid usage from current package (3y3)
  • Allow to replace liquid implementation in transformer (3y3)
  • Extract lint to @diplodoc/md-lint package (3y3)
  • Add deprecation warning for lint usage from current package (3y3)
  • Reimplement highlighte.js connection (?)

Syntax

  • ? Add sup by default
  • ? Add underline by default
  • ? Add task list by default

API

  • ? Migrate to ESM with cjs compatibility
  • Limit exported API by package.exports
@ogonkov
Copy link
Contributor

ogonkov commented Sep 20, 2024

Can we move highlight.js initialization outside of markdown transformation?

To be able load it asynchronously for example

import t from '@diplodoc/transform';

import('highlight.js').then((highlightJsFn) => t(content, {highlight: highlightJsFn}))

@ogonkov
Copy link
Contributor

ogonkov commented Sep 27, 2024

Transform has some weak typings, for example in options, that allows any key

[x: string]: unknown;

That would be great to replace it with generic, to force people correctly type their options

@shevnv
Copy link
Contributor

shevnv commented Oct 5, 2024

Syntax

@d3m1d0v
Copy link
Member

d3m1d0v commented Oct 15, 2024

Let's remove re-exports of extensions:

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

No branches or pull requests

4 participants