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

chore: Run Markdownlint rules on l10n-zh docs #5841

Merged
merged 2 commits into from
May 27, 2022

Conversation

nschonni
Copy link
Contributor

Ran markdownlint using the .markdownlint.json file from the content repo.
There were a bunch of changes, but batching by language folder

@nschonni nschonni requested a review from a team as a code owner May 26, 2022 21:27
@nschonni nschonni requested review from irvin and removed request for a team May 26, 2022 21:27
@github-actions github-actions bot added the l10n-zh Issues related to Chinese content. label May 26, 2022
@nschonni nschonni marked this pull request as draft May 26, 2022 21:30
@nschonni nschonni marked this pull request as ready for review May 26, 2022 21:44
@nschonni nschonni requested review from a team and Guyzeroth and removed request for a team May 26, 2022 21:44
@github-actions
Copy link
Contributor

github-actions bot commented May 26, 2022

Preview URLs

Flaws

Note! 6 documents with no flaws that don't need to be listed. 🎉

URL: /zh-TW/docs/Web/API/Document/scroll_event
Title: Document: scroll事件
on GitHub
Flaw count: 5

  • macros:
    • /zh-TW/docs/Web/API/Element/scroll_event does not exist but fell back to /en-US/docs/Web/API/Element/scroll_event
    • /zh-TW/docs/Web/API/GlobalEventHandlers/onscroll does not exist but fell back to /en-US/docs/Web/API/GlobalEventHandlers/onscroll
    • /zh-TW/docs/Web/API/SetTimeout does not exist but fell back to /en-US/docs/Web/API/setTimeout
  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback

URL: /zh-TW/docs/Web/API/MediaDevices
Title: MediaDevices
on GitHub
Flaw count: 12

  • macros:
    • /zh-TW/docs/Web/API/MediaDevices/enumerateDevices does not exist but fell back to /en-US/docs/Web/API/MediaDevices/enumerateDevices
    • /zh-TW/docs/Web/API/MediaDevices/getSupportedConstraints does not exist but fell back to /en-US/docs/Web/API/MediaDevices/getSupportedConstraints
    • /zh-TW/docs/Web/API/MediaTrackSupportedConstraints does not exist but fell back to /en-US/docs/Web/API/MediaTrackSupportedConstraints
    • /zh-TW/docs/Web/API/MediaStreamTrack does not exist but fell back to /en-US/docs/Web/API/MediaStreamTrack
    • /zh-TW/docs/Web/API/MediaDevices/getDisplayMedia does not exist but fell back to /en-US/docs/Web/API/MediaDevices/getDisplayMedia
    • and 7 more flaws omitted

URL: /zh-CN/docs/MDN/Contribute/Markdown_in_MDN
Title: MDN 的 Markdown
on GitHub
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

URL: /zh-CN/docs/MDN/Structures/Macros/Commonly-used_macros
Title: 常用的宏
on GitHub
Flaw count: 3

  • macros:
    • /zh-CN/docs/Web/API/Document/wheel_event does not exist but fell back to /en-US/docs/Web/API/Document/wheel_event
  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback

URL: /zh-CN/docs/Learn
Title: 学习 Web 开发
on GitHub
Flaw count: 6

  • broken_links:
    • Can't resolve /zh-CN/docs/Learn/Server-side/First_steps
    • Can't resolve /zh-CN/docs/Learn/Server-side
    • Can't resolve /zh-CN/docs/Learn/JavaScript
    • Can't resolve /zh-CN/docs/Learn/Accessibility
    • Can't resolve /zh-CN/docs/Learn/Performance
    • and 1 more flaws omitted

URL: /zh-CN/docs/Learn/JavaScript/First_steps/Test_your_skills:_variables
Title: 技能测试:变量
on GitHub
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (1 in common of 7 possible)

URL: /zh-CN/docs/Learn/HTML/Introduction_to_HTML/The_head_metadata_in_HTML
Title: <head>标签里有什么? Metadata-HTML中的元数据
on GitHub
Flaw count: 13

  • macros:
    • /zh-CN/docs/Web/HTML/Element/h1 does not exist but fell back to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /zh-CN/docs/Web/HTML/Element/h1 does not exist but fell back to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /zh-CN/docs/Web/HTML/Element/h1 does not exist but fell back to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /zh-CN/docs/Web/HTML/Element/h1 does not exist but fell back to /en-US/docs/Web/HTML/Element/Heading_Elements
  • broken_links:
    • Can't resolve /zh-CN/docs/Learn/HTML/Introduction_to_HTML/Getting_started
    • Can't resolve /zh-CN/docs/Learn/HTML/Introduction_to_HTML/HTML_text_fundamentals
    • Can't resolve /zh-CN/docs/Learn/HTML/Introduction_to_HTML/Getting_started#剖析html文档
    • Can use the English (en-US) link as a fallback
    • Link points to the page it's already on
    • and 4 more flaws omitted

URL: /zh-CN/docs/Learn/Front-end_web_developer
Title: Web 前端开发者
on GitHub
Flaw count: 4

  • broken_links:
    • Can't resolve /zh-CN/docs/Learn/Learning_and_getting_help
    • Can't resolve /zh-CN/docs/Learn/Learning_and_getting_help
    • Can't resolve /zh-CN/docs/Learn/CSS/styling_text
    • Can't resolve /zh-CN/docs/Learn/HTML/Forms

URL: /zh-CN/docs/Mozilla/Add-ons/WebExtensions
Title: 浏览器扩展
on GitHub
Flaw count: 4

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback

URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
Title: WeakMap
on GitHub
Flaw count: 3

  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Is currently http:// but can become https://

URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Map
Title: Map
on GitHub
Flaw count: 2

  • macros:
    • /zh-CN/docs/Web/JavaScript/Reference/String redirects to /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String
    • /zh-CN/docs/Web/JavaScript/Reference/WeakMap redirects to /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/WeakMap

URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Array
Title: Array
on GitHub
Flaw count: 2

  • bad_bcd_links:
    • no explanation!
    • no explanation!

URL: /zh-CN/docs/Web/HTTP/Headers/Content-Encoding
Title: Content-Encoding
on GitHub
Flaw count: 2

  • macros:
    • /zh-CN/docs/Glossary/representation_header does not exist but fell back to /en-US/docs/Glossary/Representation_header
    • /zh-CN/docs/Glossary/Representation_header does not exist but fell back to /en-US/docs/Glossary/Representation_header

URL: /zh-CN/docs/Web/HTML/Element/dialog
Title: <dialog>
on GitHub
Flaw count: 5

  • macros:
    • /zh-CN/docs/Web/API/HTMLDialogElement/returnValue does not exist but fell back to /en-US/docs/Web/API/HTMLDialogElement/returnValue
    • /zh-CN/docs/Web/API/HTMLDialogElement/showModal does not exist but fell back to /en-US/docs/Web/API/HTMLDialogElement/showModal
    • /zh-CN/docs/Web/API/HTMLDialogElement/close_event does not exist but fell back to /en-US/docs/Web/API/HTMLDialogElement/close_event
    • /zh-CN/docs/Web/API/HTMLDialogElement/cancel_event does not exist but fell back to /en-US/docs/Web/API/HTMLDialogElement/cancel_event
  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /zh-CN/docs/Web/CSS/@layer
Title: @layer
on GitHub
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (5 in common of 7 possible)

URL: /zh-CN/docs/Web/CSS/gradient/conic-gradient
Title: conic-gradient()
on GitHub
Flaw count: 8

  • macros:
    • /zh-CN/docs/Glossary/color_wheel does not exist but fell back to /en-US/docs/Glossary/Color_wheel
    • /zh-CN/docs/Glossary/interpolation does not exist but fell back to /en-US/docs/Glossary/Interpolation
    • /zh-CN/docs/Web/CSS/gradient/repeating-conic-gradient does not exist but fell back to /en-US/docs/Web/CSS/gradient/repeating-conic-gradient
    • /zh-CN/docs/Web/CSS/gradient/repeating-conic-gradient does not exist but fell back to /en-US/docs/Web/CSS/gradient/repeating-conic-gradient
    • /zh-CN/docs/Web/CSS/image/image does not exist but fell back to /en-US/docs/Web/CSS/image/image
    • and 2 more flaws omitted
  • translation_differences:
    • Differences in the important macros (5 in common of 13 possible)

URL: /zh-CN/docs/Web/CSS/filter
Title: filter
on GitHub
Flaw count: 11

  • macros:
    • /zh-CN/docs/Web/CSS/url() redirects to /zh-CN/docs/Web/CSS/url
    • /zh-CN/docs/Web/CSS/filter-function/blur() redirects to /zh-CN/docs/Web/CSS/filter-function/blur
    • /zh-CN/docs/Web/CSS/filter-function/brightness() redirects to /zh-CN/docs/Web/CSS/filter-function/brightness
    • /zh-CN/docs/Web/CSS/filter-function/contrast() redirects to /zh-CN/docs/Web/CSS/filter-function/contrast
    • /zh-CN/docs/Web/CSS/filter-function/drop-shadow() redirects to /zh-CN/docs/Web/CSS/filter-function/drop-shadow
    • and 6 more flaws omitted

URL: /zh-CN/docs/Web/Guide/Audio_and_video_delivery/Live_streaming_web_audio_and_video
Title: 实时传输Web音频与视频
on GitHub
Flaw count: 1

  • broken_links:
    • Can use the English (en-US) link as a fallback

URL: /zh-CN/docs/Web/API/GlobalEventHandlers/ontransitionend
Title: GlobalEventHandlers.ontransitionend
on GitHub
Flaw count: 1

  • macros:
    • /zh-CN/docs/Web/API/TransitionEvent/elapsedTime does not exist but fell back to /en-US/docs/Web/API/TransitionEvent/elapsedTime

URL: /zh-CN/docs/Web/API/DataTransfer/clearData
Title: DataTransfer.clearData()
on GitHub
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (3 in common of 5 possible)

URL: /zh-CN/docs/Web/API/Element/getBoundingClientRect
Title: Element.getBoundingClientRect()
on GitHub
Flaw count: 3

  • images:
    • External image URL
  • image_widths:
    • 'width' and 'height' set in 'style' attribute on <img> tag.
  • translation_differences:
    • Differences in the important macros (2 in common of 6 possible)

URL: /zh-CN/docs/Web/API/Element/scrollHeight
Title: Element.scrollHeight
on GitHub
Flaw count: 2

  • macros:
    • Unknown macro domref
  • translation_differences:
    • Differences in the important macros (3 in common of 5 possible)

URL: /zh-CN/docs/Web/API/Fetch_API/Using_Fetch
Title: 使用 Fetch
on GitHub
Flaw count: 8

  • macros:
    • /zh-CN/docs/Web/API/Request/arrayBuffer does not exist but fell back to /en-US/docs/Web/API/Request/arrayBuffer
    • /zh-CN/docs/Web/API/Request/blob does not exist but fell back to /en-US/docs/Web/API/Request/blob
    • /zh-CN/docs/Web/API/Request/formData does not exist but fell back to /en-US/docs/Web/API/Request/formData
    • /zh-CN/docs/Web/API/Request/json does not exist but fell back to /en-US/docs/Web/API/Request/json
    • /zh-CN/docs/Web/API/Request/text does not exist but fell back to /en-US/docs/Web/API/Request/text
  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
  • translation_differences:
    • Differences in the important macros (1 in common of 4 possible)

External URLs

URL: /zh-TW/docs/Web/API/Document/scroll_event
Title: Document: scroll事件
on GitHub


URL: /zh-TW/docs/Web/API/MediaDevices
Title: MediaDevices
on GitHub

No new external URLs


URL: /zh-CN/docs/MDN/Contribute/Markdown_in_MDN
Title: MDN 的 Markdown
on GitHub

No new external URLs


URL: /zh-CN/docs/MDN/Structures/Macros/Commonly-used_macros
Title: 常用的宏
on GitHub


URL: /zh-CN/docs/Learn
Title: 学习 Web 开发
on GitHub

No new external URLs


URL: /zh-CN/docs/Learn/JavaScript/First_steps/Test_your_skills:_variables
Title: 技能测试:变量
on GitHub

No new external URLs


URL: /zh-CN/docs/Learn/HTML/Introduction_to_HTML/The_head_metadata_in_HTML
Title: <head>标签里有什么? Metadata-HTML中的元数据
on GitHub

No new external URLs


URL: /zh-CN/docs/Learn/Front-end_web_developer
Title: Web 前端开发者
on GitHub

No new external URLs


URL: /zh-CN/docs/Mozilla/Add-ons/WebExtensions
Title: 浏览器扩展
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
Title: WeakMap
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Map
Title: Map
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Object/is
Title: Object.is()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Array
Title: Array
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce
Title: Array.prototype.reduce()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/JavaScript/Reference/Statements/let
Title: let
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/HTTP/Headers/Content-Encoding
Title: Content-Encoding
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/HTML/Element/dialog
Title: <dialog>
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/CSS/@layer
Title: @layer
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/CSS/gradient/conic-gradient
Title: conic-gradient()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/CSS/filter
Title: filter
on GitHub


URL: /zh-CN/docs/Web/Guide/Audio_and_video_delivery/Live_streaming_web_audio_and_video
Title: 实时传输Web音频与视频
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/HTMLCanvasElement/toBlob
Title: HTMLCanvasElement.toBlob()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/GlobalEventHandlers/ontransitionend
Title: GlobalEventHandlers.ontransitionend
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/DataTransfer/clearData
Title: DataTransfer.clearData()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/Element/getBoundingClientRect
Title: Element.getBoundingClientRect()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/Element/scrollHeight
Title: Element.scrollHeight
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/Navigator/sendBeacon
Title: Navigator.sendBeacon()
on GitHub

No new external URLs


URL: /zh-CN/docs/Web/API/Location/reload
Title: location.reload()
on GitHub


URL: /zh-CN/docs/Web/API/Fetch_API/Using_Fetch
Title: 使用 Fetch
on GitHub

(this comment was updated 2022-05-27 00:25:53.540907)

@yin1999 yin1999 changed the title chore: Run Markdownlint rules on zh-tw docs chore: Run Markdownlint rules on l10n-zn docs May 27, 2022
@yin1999 yin1999 changed the title chore: Run Markdownlint rules on l10n-zn docs chore: Run Markdownlint rules on l10n-zh docs May 27, 2022
Code spans swallow trailing/leading space, but the space is important

Co-authored-by: A1lo <yin199909@aliyun.com>
Copy link
Member

@yin1999 yin1999 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thank you!

@yin1999 yin1999 merged commit 6aed808 into mdn:main May 27, 2022
@nschonni nschonni deleted the markdownlint-zh-tw branch May 27, 2022 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
l10n-zh Issues related to Chinese content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants