[FEATURE] Enable basic Markdown files #640
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
linawolf
added a commit
to TYPO3-Documentation/render-guides
that referenced
this pull request
Oct 29, 2023
Markdown rendering still has a lot of flaws that are adressed in phpDocumentor/guides#640 Some errors are fixed there (like the warnings going to the log instead of the console and output of simple paragraphs) For others I added skiped tests
linawolf
added a commit
to TYPO3-Documentation/render-guides
that referenced
this pull request
Oct 29, 2023
Markdown rendering still has a lot of flaws that are adressed in phpDocumentor/guides#640 Some errors are fixed there (like the warnings going to the log instead of the console and output of simple paragraphs) For others I added skiped tests For now the rendering can be tried out with ddev exec vendor/bin/guides fixtures/markdown output --input-file=README.md
linawolf
force-pushed
the
feature/markdown
branch
3 times, most recently
from
89bc794 to
f297861
Compare
jaapio
reviewed
Oct 30, 2023
Member
jaapio
left a comment
jaapio
left a comment
There was a problem hiding this comment.
This looks pretty good! Thanks for this amazing amount of work. This seems to set a good foundation of future development to support more markdown features.
Just some minor changes to finalize this.
packages/guides-markdown/src/Markdown/Parsers/BlockQuoteParser.php
Outdated
Show resolved
Hide resolved
...ges/guides-markdown/src/Markdown/Parsers/InlineParsers/AbstractInlineTextDecoratorParser.php
Show resolved
Hide resolved
Add skipped tests for features still missing
This reduces confusion with for example the Paragraph Nodes
to reduce duplicate code
linawolf
force-pushed
the
feature/markdown
branch
from
d9ad320 to
919b187
Compare
jaapio
approved these changes
Oct 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most basic block and inline formats are covered now.
Markdown - different from rst - allows nested inline elements (a strong text that is also emphasized, link texts with inline code, ...) Our nodes can currently not store such information therefore we cannot support them currently.
Images are considered inline in Markdown and can appear within texts while images in rst are block level elements. I therefore had to introduce a new Node Type for inline images.
League\CommonMark Does not seem to support line-breaks (https://www.markdownguide.org/basic-syntax/#line-breaks) so these are also missing.
I did not implement https://www.markdownguide.org/basic-syntax/#html due to the security concerns.