Skip to content

Tomthorogood/md docs #3441

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
merged 6 commits into from
Jul 12, 2023
Merged

Tomthorogood/md docs #3441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
32cc5e4
Render prop documentation descriptions as markdown
tomthorogood May 24, 2023
1b01708
Add react-markdown package dependency.
tomthorogood May 24, 2023
3ca0db9
Add changeset
tomthorogood Jun 21, 2023
59025e5
Undo an unintended change.
tomthorogood Jun 21, 2023
428213b
Merge branch 'main' into tomthorogood/md-docs
broccolinisoup Jul 7, 2023
f219fb1
Merge branch 'main' into tomthorogood/md-docs
broccolinisoup Jul 12, 2023
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
5 changes: 5 additions & 0 deletions .changeset/four-bulldogs-hope.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Renders docs.json markdown content
5 changes: 3 additions & 2 deletions docs/src/props-table.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import React from 'react'
import {Box, Link, Label} from '@primer/react'
import Table from '@primer/gatsby-theme-doctocat/src/components/table'
import InlineCode from '@primer/gatsby-theme-doctocat/src/components/inline-code'
import Table from '@primer/gatsby-theme-doctocat/src/components/table'
import ReactMarkdown from 'react-markdown'

function PropsTable({children}) {
return (
Expand Down Expand Up @@ -67,7 +68,7 @@ function Row({name, type, defaultValue, description, required, deprecated}) {
{defaultValue}
</Box>
<Box as="td" verticalAlign="top">
{description}
<ReactMarkdown components={{a: Link, code: InlineCode}}>{description}</ReactMarkdown>
</Box>
</tr>
)
Expand Down
Loading