Skip to content

Use Note Alert in README.md #244

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

Closed
wants to merge 1 commit into from
Closed

Conversation

Fayti1703
Copy link
Contributor

Minor README change. GitHub has support for "alerts" like this:

Note

This is an alert of type "Note"

which imo looks better than the current solution of a blockquote.

@samualtnorman
Copy link
Owner

that readme also makes its way onto the npm page, do you know if npm's markdown supports that syntax? ideally I need a way of approving an @dev tagged publish for PRs so I can test this without having to merge your change into main

@Fayti1703
Copy link
Contributor Author

Unfortunately NPM doesn't appear to render these quite properly:
image

@SarahIsWeird
Copy link
Contributor

@samualtnorman
Copy link
Owner

Currently, the way the NPM package get its README is by copying the README.md from root into dist:

cp LICENSE README.md env.d.ts dist

I will not merge this PR in its current state due to NPM not supporting GitHub's extended markdown syntax.

I will merge this PR however if you amend the package build step in a way that a broken markdown file won't make its way to NPM.
e.g. by creating a new markdown file that package.sh instead copies to dist or maybe writing a script that transforms GitHub's extended syntax into regular markdown.

If you don't fancy that, just close this PR

Copy link
Owner

@samualtnorman samualtnorman left a comment

Choose a reason for hiding this comment

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

please see my comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants