docs: readme updates #993

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

Merged

rafegoldberg merged 1 commit into next from docs/update-mdx-readme

Oct 11, 2024

Contributor

rafegoldberg commented Oct 11, 2024 •

edited

Loading

🧰 Changes

combined and simplified the Getting Started and Usage sections
normalized subheadings under the API and Types sections for easier scanability
other minor, miscellaneous copy edits


          docs: readme updates

rafegoldberg requested review from kellyjosephprice and trishaprile

October 11, 2024 16:43

kellyjosephprice approved these changes

View reviewed changes

rafegoldberg merged commit 3a4e30d into next

13 checks passed

rafegoldberg deleted the docs/update-mdx-readme branch

October 11, 2024 17:02

rafegoldberg pushed a commit that referenced this pull request


          build(release): 🚀 v7.6.7 🦉

9b9671e

## Version 7.6.7

### ✨ New & Improved

* **Image:** match new alignment selectors ([#992](#992)) ([73bca2b](73bca2b))

### 🛠 Fixes & Updates

* better tag handling ([#991](#991)) ([e6aa82d](e6aa82d))
* respect the top-level `copyButtons` option ([#990](#990)) ([1242413](1242413)), closes [#964](#964) [/github.com/readmeio/markdown/blob/96f9644f04e6d8e3ffff6f9c014432f901c0b804/lib/compile.ts#L28](https://github.com/readmeio//github.com/readmeio/markdown/blob/96f9644f04e6d8e3ffff6f9c014432f901c0b804/lib/compile.ts/issues/L28) [/github.com/readmeio/markdown/blob/96f9644f04e6d8e3ffff6f9c014432f901c0b804/lib/compile.ts#L28](https://github.com/readmeio//github.com/readmeio/markdown/blob/96f9644f04e6d8e3ffff6f9c014432f901c0b804/lib/compile.ts/issues/L28) [/github.com/readmeio/markdown/blob/b9502adb306f099cd91e005df17c0be252019814/options.js#L1-L22](https://github.com/readmeio//github.com/readmeio/markdown/blob/b9502adb306f099cd91e005df17c0be252019814/options.js/issues/L1-L22)

### 📘 Tests & Docs

* readme updates ([#993](#993)) ([3a4e30d](3a4e30d))

<!--SKIP CI-->

Contributor Author

rafegoldberg commented Oct 14, 2024

This PR was released!

🚀 Changes included in v7.6.7

rafegoldberg added the released label

rafegoldberg pushed a commit that referenced this pull request


          build(release): 🚀 v7.11.0 🦉

23e7751

## Version 7.11.0
### ✨ New & Improved

* add title props to plain ([#1036](#1036)) ([a3b7f50](a3b7f50))

### 🛠 Fixes & Updates

* **deps:** bump debug from 4.3.7 to 4.4.0 ([#1038](#1038)) ([a5a8061](a5a8061))
* **deps:** bump readmeio/rdme from 8 to 9 ([#1037](#1037)) ([3f403de](3f403de)), closes [/github.com/readmeio/rdme/blob/HEAD/#migrating-to-rdme10](https://github.com/readmeio//github.com/readmeio/rdme/blob/HEAD//issues/migrating-to-rdme10) [#1099](#1099) [#1085](#1085) [#1106](#1106) [#1107](#1107) [#1068](#1068) [#962](#962) [#1067](#1067) [github.com/readmeio/rdme/blob/d01d76fe3c2e4a98b4f5c415be03e589fbe3b56e/.releaserc.yml#L30](https://github.com/readmeio/github.com/readmeio/rdme/blob/d01d76fe3c2e4a98b4f5c415be03e589fbe3b56e/.releaserc.yml/issues/L30) [#1067](#1067) [#1072](#1072) [#1100](#1100) [#1078](#1078) [#1042](#1042) [#908](#908) [#901](#901) [#1073](#1073) [#1080](#1080) [#961](#961) [#963](#963) [#993](#993) [github.com/nodejs/node/blob/main/doc/changelogs/CHANGELOG_V20.md#2023-11-22-version-20100](https://github.com/readmeio/github.com/nodejs/node/blob/main/doc/changelogs/CHANGELOG_V20.md/issues/2023-11-22-version-20100) [#965](#965) [#1080](#1080) [#1106](#1106) [#1105](#1105) [#1098](#1098) [#1099](#1099) [#1100](#1100)
* dont treat escapes as flow ([#1040](#1040)) ([4692ece](4692ece))

<!--SKIP CI-->

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

Labels