Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🌐 Fix incorrect pymdown-extensions option used in CJK characters documentation#12161

Closed
andychucs wants to merge 3 commits into
fastapi:masterfrom
andychucs:CJK-docs
Closed

🌐 Fix incorrect pymdown-extensions option used in CJK characters documentation#12161
andychucs wants to merge 3 commits into
fastapi:masterfrom
andychucs:CJK-docs

Conversation

@andychucs

@andychucs andychucs commented Sep 8, 2024

Copy link
Copy Markdown

The smart_enable option makes the docs not supported to be displayed when using bold and italics which are in Chinese, Japanese, and Korean.

We basically don’t use whitespace between words in Chinese and Japanese.

It causes a lot of problems with Markdown convert. So it should not be set as all just keep default is correct for now.

Check the difference here with search '**' in web documents.

Chinese:

after: https://42bebad1.fastapitiangolo.pages.dev/zh/#sponsors
截屏2024-09-08 10 24 28

before: https://fastapi.tiangolo.com/zh/#sponsors
截屏2024-09-08 10 17 11

Japanese:

after: https://42bebad1.fastapitiangolo.pages.dev/ja/#sponsors
截屏2024-09-08 10 24 59

before: https://fastapi.tiangolo.com/ja/#sponsors
截屏2024-09-08 10 23 32

Korean case like this one: #12142

@github-actions

github-actions Bot commented Sep 8, 2024

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 9c7d68c at: https://42bebad1.fastapitiangolo.pages.dev

@andychucs andychucs changed the title fix: should not use 'pymdownx.betterem' with 'smart_enable' option in CJK characters docs 🌐 Fix incorrect pymdown-extensions option used in CJK characters documentation Sep 8, 2024
@svlandeg svlandeg added docs Documentation about how to use FastAPI lang-zh Chinese translations lang-ja Japanese translations lang-ko Korean translations lang-zh-hant Traditional Chinese translations labels Sep 9, 2024

@svlandeg svlandeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for identifying and fixing this issue, @andychucs! This seems like the best way to approach this issue to me.

@sodaMelon

Copy link
Copy Markdown

Thanks for the work. if this pr get merged, I'll close #12148 #12142 #12141 #12136

@sodaMelon

Copy link
Copy Markdown

hi @svlandeg when will it merge?
If this issue is not resolved, it will be difficult to contribute for docs by CN/KO/JP.

@svlandeg

Copy link
Copy Markdown
Member

Hi @sodaMelon,

We've currently got this in our internal queue for Tiangolo to perform a final review. Thanks for your patience!

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit f75d55a at: https://185c3339.fastapitiangolo.pages.dev

@alejsdev

Copy link
Copy Markdown
Member

Hi @andychucs
This was handled in PR #12509, it should be fixed now. so I'm going to close this one but thanks for the interest and effort! 🙌

@alejsdev alejsdev closed this Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation about how to use FastAPI lang-ja Japanese translations lang-ko Korean translations lang-zh Chinese translations lang-zh-hant Traditional Chinese translations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants