Rewrite code blocks from markdown style to asciidoc style #27217
Conversation
This file contains 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
Since asciidoc parser, which is used for generating localized sites(ja.quarkus.io, cn.quarkus.io, and es.quarkus.io) cannot parse Markdown style code block, some localized docs are broken: https://ja.quarkus.io/guides/building-native-image https://cn.quarkus.io/guides/building-native-image It is not easy to fix the parser, this commit rewrites code blocks from markdown style to asciidoc style
|
We were already trying to avoid that but let's be even more strict about it from now on. /cc @quarkusio/documentation |
|
@gsmet Thank you for notifying the docs team! :) Our writers are working Erin on drafting some style guidelines for community docs (not really extensive ones, more like basic do's and don'ts). Consistency-oriented recommendations like this one should be a part of them. |
ynojima
deleted the
rewrite-code-block-from-markdown-style-to-asciidoc-style
branch
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.
Since the asciidoc parser that is used for generating localized
sites(ja.quarkus.io, cn.quarkus.io, and es.quarkus.io) cannot parse
Markdown style code block, some localized docs are broken:
https://ja.quarkus.io/guides/building-native-image
https://cn.quarkus.io/guides/building-native-image
As it is not easy to fix the parser, this commit rewrites code blocks
from markdown style to asciidoc style