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: readme updates #993

Merged
merged 1 commit into from
Oct 11, 2024
Merged

docs: readme updates #993

merged 1 commit into from
Oct 11, 2024

Conversation

rafegoldberg
Copy link
Contributor

@rafegoldberg 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

@rafegoldberg rafegoldberg merged commit 3a4e30d into next Oct 11, 2024
13 checks passed
@rafegoldberg rafegoldberg deleted the docs/update-mdx-readme branch October 11, 2024 17:02
rafegoldberg pushed a commit that referenced this pull request Oct 14, 2024
@semantic-release-bot
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-->
@rafegoldberg
Copy link
Contributor Author

This PR was released!

🚀 Changes included in v7.6.7

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

@kellyjosephprice kellyjosephprice kellyjosephprice approved these changes

@trishaprile trishaprile Awaiting requested review from trishaprile

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rafegoldberg @kellyjosephprice