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

中文內容排版風格 #317

Open
toomore opened this issue Nov 8, 2023 · 1 comment
Open

中文內容排版風格 #317

toomore opened this issue Nov 8, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@toomore
Copy link
Collaborator

toomore commented Nov 8, 2023

建立中文內容排版風格規劃,可以參考 sparanoid/chinese-copywriting-guidelines 提供的規範使用,讓後續參與人員可以保持一致的寫作風格。

@toomore toomore added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 8, 2023
@ben196888
Copy link
Collaborator

謝謝 @toomore 建議中英文混合的文件撰寫風格,我想這裡可以分成幾個步驟來做自動 linting 處理。如果只在文件標題中提到如何撰寫中英文混合的風格,最後還是會需要人眼進行校對。

我相信 code review 中人眼、人腦應該只用來檢查內容,而不是檢查排版,將排版交給電腦處理會更為適當。況且一般 github 的文件檔多使用 markdown 語法,markdown 語法中會需要套用各種符號來完成文件的排版與格式,以人眼處理起來更為複雜。

目前 survey 上述規範後,有機會使用的工具為在 nodejs 環境下執行的 linter https://github.com/huacnlee/autocorrect/tree/main/autocorrect-node 與 prettier plugin https://github.com/un-ts/prettier/tree/master/packages/autocorrect

這部份的計畫如下

  1. 完善 homepage 的 CI/CD pipeline feat(workflow): add homepage CI pipeline #138
  2. 在 CI/CD pipeline 中,將 homepage 底下非 CMS 生成的 markdown 文件以 prettier or autocorrect linter 校對。linter 校對不過的 pull request 無法合併進 main branch 中。
  3. 在 CMS 儲存文件的步驟中增加 linter 的校對與修正,凡是以 CMS 編輯儲存的文件皆會經過 linter 的校對。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants