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

Rework Markdown support to enable swappable engines #11

Closed
pydsigner opened this issue Aug 15, 2022 · 2 comments
Closed

Rework Markdown support to enable swappable engines #11

pydsigner opened this issue Aug 15, 2022 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@pydsigner
Copy link
Owner

pydsigner commented Aug 15, 2022 •
edited
Loading

Replace md_parser and md_renderer arguments to JinjaMarkdownStep with parse and render methods. Default behavior could be to use commonmark, or to detect several different markdown libraries and use them. Good choices are commonmark, markdown-it-py, markdown, and mistletoe.
@pydsigner pydsigner added the enhancement New feature or request label Aug 20, 2022
@pydsigner
Copy link
Owner Author

Post #6, this should be supplemented with specific subclasses using specific libraries, and the multiple library support in the base class should be modeled with OR-ed dependencies.

@pydsigner pydsigner added the good first issue Good for newcomers label Aug 20, 2022
pydsigner added a commit that referenced this issue Aug 23, 2022
@pydsigner
Update Steps with dependencies to use the new dependency framework
10f6f93 
JinjaMarkdownStep only half-works and needs a bigger rework a la #11
@pydsigner
Copy link
Owner Author

commonmark is deprecated and should not be the default: readthedocs/commonmark.py#308

pydsigner added a commit that referenced this issue Jul 16, 2023
@pydsigner
Improve Dependency system and add helpers (#11)
d319f9c
pydsigner added a commit that referenced this issue Jul 16, 2023
@pydsigner
Make JinjaMarkdownStep interact with dependency system properly (#11)
d7fecd9
pydsigner added a commit that referenced this issue Jul 17, 2023
@pydsigner
Rework jinja.JinjaMarkdownStep to support multiple markdown engines (#11
7a8a79a 
)

Retains support for commonmark but makes markdown-it-py the default
pydsigner added a commit that referenced this issue Jul 17, 2023
@pydsigner
Update default markdown engine to markdown_it_py in project dependenc…
9d89ca3 
…ies (#11)
pydsigner added a commit that referenced this issue Jul 17, 2023
@pydsigner
Merge pull request #16 from pydsigner/markdown_dependency_fix
fcb9fd1 
Markdown support enhancement (#11)
pydsigner added a commit that referenced this issue Jul 17, 2023
@pydsigner
Add support for the markdown markdown engine (#11)
3234057
pydsigner added a commit that referenced this issue Jul 17, 2023
@pydsigner
Add support for the mistletoe markdown engine (#11)
3355533
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pydsigner