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

Clean Markdown with dedent to respect indents #16414

Merged
merged 1 commit into from
Jun 13, 2021

Conversation

uranusjr
Copy link
Member

Close #16263, close #16138.

Note that the current Markdown engine does not support fenced code blocks, so it still won’t work after this change. Python-Markdown’s fenced code support is pretty spotty, and if we want to fix that for good IMO we should switch to another Markdown parser. markdown-it-py (the parser backing MyST) is a popular choice for CommonMark support, which is much closer to GitHub-Flavored Markdown which almost everyone thinks is the standard Markdown (which is unfortunately because GFM is not standard, but that’s how the world works).

@boring-cyborg boring-cyborg bot added the area:webserver Webserver related Issues label Jun 12, 2021
@potiuk potiuk merged commit 6f9c0ce into apache:main Jun 13, 2021
@uranusjr uranusjr deleted the dag-md-doc-indent branch June 13, 2021 00:55
@ashb ashb added this to the Airflow 2.1.1 milestone Jun 14, 2021
@kaxil
Copy link
Member

kaxil commented Jun 14, 2021

@uranusjr Can you create a Github Issue to switch the markdown library to markdown-it-py ? :)

@uranusjr
Copy link
Member Author

Done in #16435.

ashb pushed a commit that referenced this pull request Jun 22, 2021
kaxil pushed a commit to astronomer/airflow that referenced this pull request Jun 22, 2021
(cherry picked from commit 6f9c0ce)
(cherry picked from commit 4c06aae)
kaxil pushed a commit to astronomer/airflow that referenced this pull request Jun 23, 2021
(cherry picked from commit 6f9c0ce)
(cherry picked from commit 4c06aae)
(cherry picked from commit 26abb8d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:webserver Webserver related Issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to use nested lists in DAG markdown documentation doc_md code block collapsing lines
4 participants