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

enhancement/issue 1320 upgrade markdown related dependencies to latest #1371

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

thescientist13
Copy link
Member

@thescientist13 thescientist13 commented Dec 30, 2024

Related Issue

resolves #1320

Documentation

  1. Document removal of settings option from markdown configuration

Summary of Changes

  1. Upgrade all markdown related dependencies
  2. Remove support for markdown settings configuration (since remark-parse no longer takes any options - https://www.npmjs.com/package/remark-parse#api)

GFM

Can confirm this is all working now and outputting the expected HTML
https://www.npmjs.com/package/remark-gfm/v/1.0.0#use

Screenshot 2024-12-30 at 1 48 26 PM

Definitions List

The reported issue with <dl> rendering seems more to do with just general formatting around markdown in general. For example, looking at the file in an IDE with and without indentation, we can see syntax highlight lighting up in the formatted version

Screenshot 2024-12-30 at 2 38 33 PM
Screenshot 2024-12-30 at 2 38 57 PM
Screenshot 2024-12-30 at 2 57 23 PM

For example, markdown formatting inside HTML blocks will just get processed as HTML per the spec, so pretty much I think this is all working as expected.

An HTML block is a group of lines that is treated as raw HTML (and will not be escaped in HTML output).

TODO

  1. validate definitions list
  2. see if any of this helps with - hyphens and quotes in markdown code fence results in missing content with production builds #1325 - no luck unfortunately
  3. remove demo code

@thescientist13 thescientist13 added enhancement Improve something existing (e.g. no docs, new APIs, etc) documentation Greenwood specific docs CLI breaking bug Something isn't working labels Dec 30, 2024
@thescientist13 thescientist13 marked this pull request as ready for review December 31, 2024 01:51
@thescientist13 thescientist13 changed the title enhancement/issue 1320 upgrade markdown related plugins and update internal implementation enhancement/issue 1320 upgrade markdown related dependencies to latest Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking bug Something isn't working CLI documentation Greenwood specific docs enhancement Improve something existing (e.g. no docs, new APIs, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better support for Markdown
1 participant