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

add gfm markdown to turndown #916

Merged
merged 2 commits into from
Dec 5, 2024
Merged

add gfm markdown to turndown #916

merged 2 commits into from
Dec 5, 2024

Conversation

pelikhan
Copy link
Member

@pelikhan pelikhan commented Dec 5, 2024


Summary of High-Level Changes 🌐

  • Added Dependency:

    • A new dependency turndown-plugin-gfm has been added to both packages/package.json of the core and core sub-package. This plugin enhances Turndown's ability to convert HTML to Markdown, specifically for GitHub Flavored Markdown (GFM).
  • Enhanced Conversion Logic:

    • In packages/core/src/html.ts, the conversion logic for transforming HTML to Markdown has been improved. It now uses the turndown-plugin-gfm plugin to better handle GFM syntax when converting.
    • This enhancement is crucial for ensuring that the output Markdown adheres more closely to GitHub's markdown formatting, which is essential for consistency and usability in environments that rely on GFM.

These changes focus on enhancing the functionality of HTML to Markdown conversion, making sure it supports a broader range of text formatting features, particularly those specific to GitHub. This update enhances compatibility and utility for applications integrating or utilizing this Markdown conversion capability.

generated by pr-describe


  • 🔧 Added turndown-plugin-gfm Dependency: Introduced the turndown-plugin-gfm package to enhance markdown conversion capabilities with GitHub Flavored Markdown support.
  • 🚀 Updated Build Scripts: Modified compile and compile-debug scripts to include turndown-plugin-gfm as an external dependency, ensuring compatibility with the new plugin.
  • 📝 Enhanced HTML to Markdown Conversion: Integrated turndown-plugin-gfm in the HTML to Markdown conversion process to support GitHub Flavored Markdown, improving markdown output quality.

generated by prd

Copy link

github-actions bot commented Dec 5, 2024

Investigator report

, 1e33e3d

generated by gai

Copy link

github-actions bot commented Dec 5, 2024

LGTM 🚀

Changes look good! The addition of the GitHub Flavored Markdown plugin enhances the conversion process, ensuring better compatibility with Markdown standards used on platforms like GitHub.

generated by pr-review

@pelikhan pelikhan merged commit f2bf5c6 into main Dec 5, 2024
9 checks passed
@pelikhan pelikhan deleted the turndown-gfm branch December 5, 2024 17:54
Copy link

github-actions bot commented Dec 5, 2024

<tool_response>
{
"workflows": [
{
"id": 66542108,
"name": "CodeQL",
"path": ".github/code-scanning/codeql"
},
{
"id": 66543451,
"name": "build",
"path": ".github/workflows/build.yml"
},
{
"id": 78417502,
"name": "cli test",
"path": ".github/workflows/cli-test.yml"
},
{
"id": 89863939,
"name": "GitHub Pages",
"path": ".github/workflows/docs.yml"
},
{
"id": 89864231,
"name": "pages-build-deployment",
"path": ".github/workflows/pages-build-deployment"
},
{
"id": 97609848,
"name": "ollama smoke tests",
"path": ".github/workflows/ollama.yml"
},
{
"id": 98312260,
"name": "genai tests",
"path": ".github/workflows/build-genai.yml"
},
{
"id": 100477653,
"name": "npm cli check",
"path": ".github/workflows/npm-check.yml"
},
{
"id": 100911957,
"name": "genai pull request commit review",
"path": ".github/workflows/genai-pr-commit-review.yml"
},
{
"id": 100913028,
"name": "genai pull request review",
"path": ".github/workflows/genai-pr-review.yml"
}
]
}
</tool_response>

generated by github-agent

Copy link

github-actions bot commented Dec 5, 2024

{"error": "Unknown tool"}

generated by github-one

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

Successfully merging this pull request may close these issues.

1 participant