Skip to content

docs: add code, cjk, math, and mermaid to @source#430

Merged
haydenbleasel merged 17 commits intovercel:mainfrom
aradhyacp:docs/update-styling-docs
Mar 3, 2026
Merged

docs: add code, cjk, math, and mermaid to @source#430
haydenbleasel merged 17 commits intovercel:mainfrom
aradhyacp:docs/update-styling-docs

Conversation

@aradhyacp
Copy link
Contributor

Description

This PR updates the documentation configuration to include all relevant @streamdown/* packages in the @source configuration.

Previously, only:

@source "../node_modules/streamdown/dist/*.js";

was included.

Now the following modules are also sourced:

  • @streamdown/code
  • @streamdown/cjk
  • @streamdown/math
  • @streamdown/mermaid
@source "../node_modules/streamdown/dist/*.js";
@source "../node_modules/@streamdown/code/dist/*.js";
@source "../node_modules/@streamdown/cjk/dist/*.js";
@source "../node_modules/@streamdown/math/dist/*.js";
@source "../node_modules/@streamdown/mermaid/dist/*.js";

This ensures all Streamdown extensions are properly included in documentation generation.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Refactoring (no functional changes)

Related Issues

Fixes #427
Closes #427
Related to #427

Changes Made

    • Expanded @source entries to include all @streamdown/* extensions
    • Ensured documentation has code, CJK, math, and mermaid modules
    • Added corresponding changeset

Testing

  • All existing tests pass
  • Added new tests for the changes
  • Manually tested the changes

Test Coverage

No runtime code changes. Documentation configuration update only.

Screenshots/Demos

N/A

Checklist

  • My code follows the project's code style
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have created a changeset (pnpm changeset)

Changeset

  • I have created a changeset for these changes

Additional Notes

This change does not affect runtime behavior. It strictly improves documentation coverage and build completeness.

@vercel
Copy link
Contributor

vercel bot commented Mar 2, 2026

@aradhyacp is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@haydenbleasel
Copy link
Contributor

@aradhyacp these sources should only be included if the relevant package is installed otherwise it will cause an error, need to note that in the docs

@haydenbleasel
Copy link
Contributor

it may be worth adding them to the individual plugin pages rather than the getting started / setup docs

@aradhyacp
Copy link
Contributor Author

cool, i will push the required changes asap :)

@aradhyacp
Copy link
Contributor Author

@haydenbleasel changes are in let me know if any changes required :)

@haydenbleasel
Copy link
Contributor

awesome thanks @aradhyacp 🙏

@haydenbleasel haydenbleasel merged commit 5edff75 into vercel:main Mar 3, 2026
3 of 6 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.

Update styling docs

2 participants