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

Add docs on how to use w/ rehype-sanitize #68

Merged
merged 6 commits into from
Oct 9, 2021
Merged

Add docs on how to use w/ rehype-sanitize #68

merged 6 commits into from
Oct 9, 2021

Conversation

maclockard
Copy link
Contributor

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Mention in the docs how to safely configure rehype-sanitize to allow the required class names for remark-math

Fixes #67

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Oct 1, 2021
wooorm
wooorm reviewed Oct 1, 2021
View reviewed changes
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

nice! Just some nits.

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
maclockard and others added 2 commits October 1, 2021 11:54
@maclockard @wooorm
Apply suggestions from code review
8821066 
Co-authored-by: Titus <tituswormer@gmail.com>
@maclockard
run format
af6ac1b
wooorm
wooorm reviewed Oct 8, 2021
View reviewed changes
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

some style nits, otherwise good to go!

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@wooorm
Copy link
Member

wooorm commented Oct 8, 2021

The CI failure was unrelated to your work. I’ve fixed it on main, so rebasing against that should solve it.

@codecov-commenter

This comment has been minimized.

Sign in to view
@wooorm wooorm changed the title Mention how to configure rehype-sanitize in README Add docs on how to use w/ rehype-sanitize Oct 9, 2021
@wooorm wooorm merged commit d2f2dc7 into remarkjs:main Oct 9, 2021
@wooorm wooorm added the 💪 phase/solved Post is done label Oct 9, 2021
@github-actions

This comment has been minimized.

Sign in to view
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Oct 9, 2021
@wooorm
Copy link
Member

wooorm commented Oct 9, 2021

Thanks Mac!

@wooorm wooorm added 📚 area/docs This affects documentation 🦋 type/enhancement This is great to have labels Oct 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wooorm wooorm wooorm approved these changes

@ChristianMurphy ChristianMurphy ChristianMurphy approved these changes

Assignees
No one assigned
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done 🦋 type/enhancement This is great to have
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

rehype-sanitize breaks math rendering
4 participants
@maclockard @wooorm @codecov-commenter @ChristianMurphy