Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(docs): add explanation for NotionRenderer #315

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.

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

Open
bytrangle wants to merge 2 commits into NotionX:master
base: master
Choose a base branch
Loading
from bytrangle:patch-3

Conversation

@bytrangle
Copy link
Contributor

@bytrangle bytrangle commented Jun 29, 2022
edited
Loading

Description

NotionRenderer is one of the most important modules exported by react-notion-x. Aside from the required prop recordMap, it accepts many optional props which makes it quite confusing to use for newcomers.

Information that I added:

  • the bare bone markup when no optional props are defined for NotionRenderer
  • what fullPage prop means
  • the lowdown on props that depend on the truthiness of fullPage: header, pageHeader, footer, pageFooter!

Notion Test Page ID

cc368b47772a4a1aa36e1f52c507d20d

Copy link

vercel bot commented Jun 29, 2022
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
react-notion-x ❌ Failed (Inspect) Jun 30, 2022 at 3:32PM (UTC)
react-notion-x-minimal-demo ✅ Ready (Inspect) Visit Preview Jun 30, 2022 at 3:32PM (UTC)

@bytrangle bytrangle changed the title (削除) docs: add explanation for NotionRenderer (削除ここまで) (追記) feat(docs): add explanation for NotionRenderer (追記ここまで) Jun 30, 2022
Copy link
Contributor Author

Hello @transitive-bullshit This PR is a doc update. What else can I do to speed this up?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /