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.

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

Rewrite readme for unified, more examples #485

Merged
merged 13 commits into from
Oct 17, 2020
Merged

Rewrite readme for unified, more examples #485

merged 13 commits into from
Oct 17, 2020

Conversation

wooorm
Copy link
Member

@wooorm wooorm commented Oct 16, 2020

See rendered readme: https://github.com/remarkjs/react-markdown/tree/docs#readme

  • Lowercase filenames to scream less
  • Add remark-cli, remark-preset-wooorm to format prose
  • Use imports and fancy new JS features
  • Add link to a markdown cheatsheet, as many questions are about that
  • Add details tags showing equivalent JSX for examples, to clarify how markdown works
  • Refactor options list, clean signatures
  • Add examples on plugins, plugins w/ options, renderers (syntax highlighting), and combining plugins w/ renderers (math)
  • Add sections on why to use this, security, contributing, related projects
  • Add test for react-katex integration

Closes GH-70.
Closes GH-191.
Related to GH-474.
Closes GH-479.
Closes GH-480.
Related to GH-483.

@wooorm wooorm added 📚 area/docs This affects documentation 👩‍⚕ area/health This affects community 🙆 yes/confirmed This is confirmed and ready to be worked on 🦋 type/enhancement This is great to have labels Oct 16, 2020
changelog.md Outdated Show resolved Hide resolved
changelog.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
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 Author

wooorm commented Oct 16, 2020

poor travis

wooorm and others added 13 commits October 17, 2020 12:29
* Lowercase filenames to scream less
* Add `remark-cli`, `remark-preset-wooorm` to format prose
* Use imports and fancy new JS features
* Add link to a markdown cheatsheet, as many questions are about that
* Add details tags showing equivalent JSX for examples, to clarify how markdown
  works
* Refactor options list, clean signatures
* Add examples on plugins, plugins w/ options, renderers (syntax highlighting),
  and combining plugins w/ renderers (math)
* Add sections on why to use this, security, contributing, related projects
* Add test for `react-katex` integration

Closes GH-70.
Closes GH-191.
Related to GH-474.
Closes GH-479.
Closes GH-480.
Related to GH-483.
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Copy link
Collaborator

@rexxars rexxars left a comment

Choose a reason for hiding this comment

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

👍

@wooorm wooorm merged commit b3aa6e0 into v5 Oct 17, 2020
@wooorm wooorm deleted the docs branch October 17, 2020 10:40
@wooorm wooorm added ⛵️ status/released and removed 🙆 yes/confirmed This is confirmed and ready to be worked on labels Oct 19, 2020
@wooorm wooorm added the 💪 phase/solved Post is done label Aug 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 👩‍⚕ area/health This affects community 💪 phase/solved Post is done 🦋 type/enhancement This is great to have
Development

Successfully merging this pull request may close these issues.

None yet

3 participants