Update documentation for readability

[zhangchuck]

Goal:

Update documentation for clarity.

Process:

• Using the Grammarly service to do automatic fixes, and then doing a human proofread for the entire document.
• I'll work my way through everything in the website/docs/ folder.

Status:

• /guide/
  • directives.md
  • fitting-header.md
  • fragmented-list.md
  • heading-divider.md
  • how-to-write-slides.md
  • image-syntax.md
  • math-typesetting.md
  • theme.md
• /introduction/
  • install.md
  • whats-marp.md
• /tools/ (just stubs at the moment)
  • marp-cli.md
  • marp-for-vs-code.md

[zhangchuck]

@yhatt Not sure if this would be helpful, but I thought it might be good to do a proofread of all the documentation (e.g., using Grammarly) to clean up typos and make the documentation a bit easier to use. I did one page (directives) as an example. Let me know if you'd prefer to do this yourself or you don't think this is helpful to the project.

Thanks, and appreciate all your work on this framework!

[yhatt]

Thanks for your contribution 😍

I'm not native so already have relied to Google & DeepL translator (and partially Grammarly: I rarely use because I felt its compatibillity with Markdown is not good) for checking accuracy of writing. When the result of translator from English to native language is covenying my intention exactly, I sometimes take it even if used a poor grammar.

There are still many stubs in the unified docs, and I would likely to write more sections with many mistakes in a grammar. I welcome to contributions for proofreading anytime!

[yhatt]

Preview: https://deploy-preview-140--marp.netlify.app/docs/guide/directives

[zhangchuck]

Happy to help. I'll slowly work my through the existing docs (I listed them in the draft PR) and will mark this for review once I've gone through all of them.

[yhatt]

Quick look for introdocution pages

[yhatt]

@zhangchuck Marp team is planning to change the structure of documentation about image syntax from Marpit framework drastically. By containing 2e981bc, this PR may bloat and late to merge. Please consider to revert updates for image-syntax.md and split into another pull request.

[zhangchuck]

Okay, I've reverted those changes back to the original file (i.e., just the stub).

[yhatt]

https://github.com/marp-team/marp/runs/3388494059
Please run yarn format:write on the root to apply formatting.

[zhangchuck]

Not familiar with the Node (?) ecosystem. I ended up installing and running prettier, i.e

yarn prettier --write .

[yhatt]

No problems for this PR.