Skip to content

docs: refresh multilingual content authoring guides - #546

Merged
matsuzaka-yuki merged 1 commit into
LyraVoid:masterfrom
Dawn6666666:docs/update-readme
Aug 9, 2026
Merged

docs: refresh multilingual content authoring guides#546
matsuzaka-yuki merged 1 commit into
LyraVoid:masterfrom
Dawn6666666:docs/update-readme

Conversation

@Dawn6666666

@Dawn6666666 Dawn6666666 commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Type of change

  • Bug fix (a non-breaking change that fixes an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other: documentation and example content maintenance

Checklist

  • I have read the contribution guidance referenced by the repository template.
  • I have checked to ensure that this Pull Request is not for personal-only changes.
  • I have performed a self-review of my own changes.
  • I have run the repository checks; intentionally not run for this documentation-only request.

Related Issue

Closes #545

Changes

  • Refresh the English, Simplified Chinese, Japanese, and Traditional Chinese README content-authoring entry points.
  • Add multilingual content-authoring guides covering current Frontmatter, Markdown/MDX extensions, media, diagrams, encryption limits, synchronization caveats, and publishing reminders.
  • Link the guides to real examples under src/content/posts/, including standard Markdown, extensions, Mermaid, image grids, video, encryption, folder-based posts, and MDX.
  • Update example posts with a current generic folder/frontmatter example, a valid video embed example, an explicit browser-side encryption demo with the repository's public demo credential, a generic MDX link example, and a data-no-enhance demonstration.
  • Keep the extension showcase article's Mizuki-specific values so it remains a project feature demonstration.
  • No runtime theme code was changed.

How To Test

Per request, no checks, tests, or builds were run. I performed a read-only review of the documentation and content diffs.

Screenshots (if applicable)

Not applicable; this PR changes documentation and demo content only.

Additional Notes

The repository's existing demo posts, page data, albums, and images are still demo content and should be removed or replaced before deploying a personal site.

Copilot AI lite review requested due to automatic review settings August 9, 2026 03:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@matsuzaka-yuki
matsuzaka-yuki merged commit dc0a792 into LyraVoid:master Aug 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: 完善 README 与多语言内容编写指南

3 participants