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.

Sign up for GitHub

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

Jump to bottom

Upgrade remarkjs #90

Closed
6 tasks done
about-code opened this issue Apr 30, 2020 · 0 comments
Closed
6 tasks done

Upgrade remarkjs #90

about-code opened this issue Apr 30, 2020 · 0 comments
Labels
maintenance Maintenance tasks
Milestone
v4.0.0

Comments

@about-code
Copy link
Owner

about-code commented Apr 30, 2020 •
edited
Loading

Dependencies:

  • remark-parse: ^8.0.0
    • replace remark-parse option footnotes: true with remark-footnotes processor plug-in where necessary (Changelog [email protected])
  • remark-stringify: ^8.0.0
  • remark-reference-links: ^5.0.0 (Changelog)
  • remark-slug: ^6.0.0 (Changelog)
  • remark-autolink-headings: ^6.0.0 (Changelog)

Dev. Dependencies:

  • remark-cli: ^8.0.0
    • major version changes only due to dependencies to remarkjs@8 and unified@8. No CLI-specific migration steps

Full Changelog
@about-code about-code added this to the v4.0.0 milestone Apr 30, 2020
@about-code about-code changed the title Upgrade to remark-stringify 8.0.0 Upgrade to remark-stringify 8.x Apr 30, 2020
@about-code about-code changed the title Upgrade to remark-stringify 8.x Upgrade to remarkjs 8 Apr 30, 2020
@about-code about-code changed the title Upgrade to remarkjs 8 Upgrade remarkjs Apr 30, 2020
about-code added a commit that referenced this issue Jun 1, 2020
@about-code
fix: Drop option 'experimentalFootnotes'.
419cd5d 
BREAKING CHANGE: `experimentalFootnotes` is no longer required and no longer
a valid configuration option. Please remove it.

> Footnotes are still not official CommonMark. However they are also not really
a feature of *glossarify-md*, thus the option doesn't provide any value and
was removed.

Internally *glossarify-md* has to use a special remark parser plug-in
[remark-footnotes](https://github.com/remarkjs/remark-footnotes)
but only to prevent [remark-stringify](https://github.com/remarkjs/remark-stringify)
transcoding `[^footnote]: Text` input syntax into `[^footnote]: Text`
by applying HTML-Entity encoding. So the use of *remark-footnotes* plug-in is only
required to prevent a bug (from a users point of view) rather than providing a
feature. Since those internal details of markdown processing shouldn't matter
to users at all, they shouldn't be required to configure `experimentalFootnotes`.

Other changes: Upgrade to remarkjs 8. Closes #90.
@about-code about-code mentioned this issue Jun 1, 2020
Merged
about-code added a commit that referenced this issue Jun 1, 2020
@about-code
fix: Drop option 'experimentalFootnotes'
a78cb2c 
BREAKING CHANGE: `experimentalFootnotes` is no longer required and no longer
a valid configuration option. Please remove it.

> Footnotes are still not official CommonMark. However they are also not really
a feature of *glossarify-md*, thus the option doesn't provide any value and
was removed.

Internally *glossarify-md* has to use a special remark parser plug-in
[remark-footnotes](https://github.com/remarkjs/remark-footnotes)
but only to prevent [remark-stringify](https://github.com/remarkjs/remark-stringify)
transcoding `[^footnote]: Text` input syntax into `[^footnote]: Text`
by applying HTML-Entity encoding. So the use of *remark-footnotes* plug-in is only
required to prevent a bug (from a users point of view) rather than providing a
feature. Since those internal details of markdown processing shouldn't matter
to users at all, they shouldn't be required to configure `experimentalFootnotes`.

Other changes: Upgrade to remarkjs 8 (#90).
@about-code about-code added the maintenance Maintenance tasks label Jun 1, 2020
@about-code about-code reopened this Jun 1, 2020
@about-code about-code mentioned this issue Jun 1, 2020
Merged
about-code added a commit that referenced this issue Aug 11, 2020
@about-code
fix: Drop option 'experimentalFootnotes'
5785aba 
BREAKING CHANGE: `experimentalFootnotes` is no longer required and no longer
a valid configuration option. Please remove it.

> Footnotes are still not official CommonMark. However they are also not really
a feature of *glossarify-md*, thus the option doesn't provide any value and
was removed.

Internally *glossarify-md* has to use a special remark parser plug-in
[remark-footnotes](https://github.com/remarkjs/remark-footnotes)
but only to prevent [remark-stringify](https://github.com/remarkjs/remark-stringify)
transcoding `[^footnote]: Text` input syntax into `[^footnote]: Text`
by applying HTML-Entity encoding. So the use of *remark-footnotes* plug-in is only
required to prevent a bug (from a users point of view) rather than providing a
feature. Since those internal details of markdown processing shouldn't matter
to users at all, they shouldn't be required to configure `experimentalFootnotes`.

Other changes: Upgrade to remarkjs 8 (#90).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
maintenance Maintenance tasks
Projects
None yet
Milestone
v4.0.0
Development

No branches or pull requests
1 participant
@about-code