Skip to content

Add installation instruction #9

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.

Sign up for GitHub

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

Merged
nick-skriabin merged 1 commit into from
Feb 21, 2026
Merged

Add installation instruction #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions packages/glyph-markdown/src/Markdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,8 +561,22 @@ export interface MarkdownProps {
* document contains code blocks. Code blocks render immediately with plain
* text, then re-render with highlighting once Shiki is ready.
*
* ## Installation
*
* This component is part of the `@semos-labs/glyph-markdown` package which
* is **not** included in the core `@semos-labs/glyph` package.
*
* ```bash
* bun add @semos-labs/glyph-markdown
* # or: npm install @semos-labs/glyph-markdown
* ```
*
* Requires `@semos-labs/glyph` and `react` as peer dependencies.
*
* @example
* ```tsx
* import { Markdown } from "@semos-labs/glyph-markdown";
*
* <Markdown>{source}</Markdown>
* ```
*
Expand Down