Skip to content
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

Jump to bottom

docs: fix mermaid theme options typo #8272

Merged
merged 2 commits into from Nov 2, 2022
Merged

docs: fix mermaid theme options typo #8272

merged 2 commits into from Nov 2, 2022

Conversation

ntucker
Copy link
Contributor

@ntucker ntucker commented Oct 31, 2022 •
edited

According to the types here https://github.com/facebook/docusaurus/blob/9c92a79d23533a61f3ad1bf3ea4d0889f0e2710f/packages/docusaurus-theme-mermaid/src/theme-mermaid.d.ts as well as runtime validation by myself - it should options not mermaidOptions.

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Docs are misleading

Test Plan

Set some options using this method and they applied

@ntucker ntucker requested a review from slorber as a code owner October 31, 2022 22:06
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 31, 2022
@netlify
Copy link

netlify bot commented Oct 31, 2022 •
edited

✅ [V2]

Name Link
🔨 Latest commit d83c323
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/63626d9ed06ec70008e3a34a
😎 Deploy Preview https://deploy-preview-8272--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Oct 31, 2022 •
edited

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟢 92 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 68 🟢 100 🟢 100 🟢 100 🟢 90 Report

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Nov 2, 2022
slorber
slorber approved these changes Nov 2, 2022
View reviewed changes
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Thanks, missed that 👍 backported to 2.2 docs too

@slorber slorber changed the title Fix mermaid theme options docs: fix mermaid theme options typo Nov 2, 2022
@slorber slorber merged commit 7387aab into facebook:main Nov 2, 2022
@ntucker ntucker deleted the patch-2 branch November 2, 2022 17:20
This was referenced Oct 19, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slorber slorber slorber approved these changes

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ntucker @slorber @facebook-github-bot