[ko] Markdown conversion for ko RoadMap

[hochan222]

목적

markdown으로 변환하기 위한 사항들을 정리하기 위한 이슈입니다. 해당 이슈는 Converting an MDN section to Markdown - Localizer's guide의 ko-locale 을 위한 이슈입니다.

• Markdown으로 변환
• 문서를 HTML에서 Markdown으로 변환하는 PR에서는 다음 두 커밋 포함한다.
  • (1) 파일 이름 바꾸기
  • (2) 실제로 파일 변환

변환 방법

2022.08 기준 html을 markdown으로 변환하는 script가 yari에서 분리되었습니다. (markdown script repo 링크)

공식 가이드: https://hacks.mozilla.org/2022/09/the-100-percent-markdown-expedition/

• 참고
  • https://github.com/mdn/markdown/blob/main/conversion-guide.md
  • https://github.com/mdn/translated-content/discussions/2474
  • https://egas.tistory.com/52?category=482046

확장자 일괄 변환

find -L . -type f -name "*.html" -print0 | while IFS= read -r -d '' FNAME; do
    mv -- "$FNAME" "${FNAME%.html}.md"
done

진행 목록

web/javascript 폴더를 시작으로 점진적으로 변환해 나갈 예정입니다.

• conflicting [ko] Markdown convertion /conflicting #7622
• games [ko] Markdown convertion /games #7623
• glossary [ko] Markdown convertion /glossary #7624
• learn [ko] Markdown convertion /learn #7625
• mdn convert mdn html to md #7579
• mozilla [ko] Markdown convertion /mozilla #7626
• web [ko] Markdown convertion /web #7621
• webassembly convert Webassembly html to md #7581

변환전 체크 사항

2022.08 기준 코드에서 체크사항들을 모두 처리해주고 있어서 더 이상 아래 작업이 불필요합니다.

web/javascript

• Remove "cruft" from the past: this is especially true for (sadly) unmaintained areas of some localized docs.
  • [ko] Remove <span>s around content, web/javascript #2898
  • [ko] Remove <font>s around content, web/javascript #2897
  • [ko] notranslate class 삭제, web/javascript #2896
• Remove id attributes when they don't belong to a heading (<h1>/<h2> etc.)
  • Be careful with live samples (EmbedLiveSample macro calls) when converting
• [ko] Remove elements with the hidden class, except for <pre>s, web/javascript #2899
• [ko] Remove summary and seoSummary classes, web/javascript #2895
• Remove inline style attributes which won't be converted

참고 사항

기울임꼴

한글은 기울임꼴에 적합하지 않습니다. 한국 문서에서는 사용하고 있지 않아 _기울임꼴_ 은 기울임꼴 이나 **기울임꼴**으로 변환합니다.

명세서

앞으로 명세서는 아래 두가지 형식만 존재합니다.

• html

<h2 id="Specifications">명세서</h2>

{{Specifications}}

• markdown

## 명세서

{{Specifications}}

브라우저 호환성

• html

<h2 id="Browser_compatibility">브라우저 호환성</h2>

{{Compat}}

• markdown

## 명세서

{{Compat}}

[SnowMarble]

안녕하세요, 마지막 체크사항에대해 궁금한점이 있어 질문드립니다.
#2474 에서 언급된 바로는 변환되지 않을 인라인 스타일 속성을 제거해고 했는데, 여기서 변환되지 않을 인라인 스타일 은 어떤걸 말하는 걸까요?

Remove inline style attributes which won't be converted

[hochan222]

안녕하세요, 마지막 체크사항에대해 궁금한점이 있어 질문드립니다. https://github.com/mdn/translated-content/discussions/2474 에서 언급된 바로는 변환되지 않을 인라인 스타일 속성을 제거해고 했는데, 여기서 변환되지 않을 인라인 스타일 은 어떤걸 말하는 걸까요?

@kraccoon-dev 님, 안녕하세요. yari의 html파일을 md 파일로 변환하는 명령어로 변환이 안되는 태그들이 있습니다. 예를 들면 span이 있습니다.

제가 이슈를 생성하지 않은 이유는 구체적인 항목을 정의하지 못해서여서, 현재는 어떤 태그들이 대상인지는 잘 모르지만, 우선은 #2307 를 참고해서 @kraccoon-dev 님께서 해당 이슈 만들어주셔도 좋을듯합니다.

[SnowMarble]

@hochan222 확인해주셔서 감사합니다! 자료를 조금 더 찾아보고 정리가 된다면 진행해보도록 하겠습니다.

[queengooborg]

Hey all -- FYI, I've written a new conversion guide at https://github.com/mdn/markdown/blob/main/conversion-guide.md with updated instructions, as many of the special cases that had to be taken care of before conversion are now automatically handled! Hope this helps with your locale's conversion!

[hochan222]

@queengooborg I was going to read it thoroughly today. Oh, Everything is already taken care of! Thanks for letting me know before work :)

[hochan222]

모든 문서 변환 완료되었습니다! 모두 고생 많으셨습니다. 🎉🎉

좋은 하루 보내세요 :)