Skip to content

Commit

Permalink
Delete TOC; add link to Migration notes (#171)
Browse files Browse the repository at this point in the history
# Description

This deletes the table of contents at the top of the readme.
- Github recently built a TOC into their UI
  - ...
- This is one less _thing_ that needs to be maintained

This adds a section + link to the V3 breaking chanes
- This took me a while to discover, and I also discovered by chance when I wanted to upgrade from V2 to V3.
  • Loading branch information
thiskevinwang committed Jul 1, 2021
1 parent 48cb27d commit ae39ed7
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,6 @@ A set of light utilities allowing mdx to be loaded within `getStaticProps` or `g

---

- [Installation](#installation)
- [Examples](#examples)
- [APIs](#apis)
- [Frontmatter & Custom Processing](#frontmatter--custom-processing)
- [Background & Theory](#background--theory)
- [Caveats](#caveats)
- [Security](#security)
- [TypeScript](#typescript)
- [License](#license)

---

## Installation

```sh
Expand Down Expand Up @@ -427,6 +415,10 @@ export const getStaticProps: GetStaticProps<MDXRemoteSerializeResult> = async ()
}
```

## Migrating from v2 to v3

See https://github.com/hashicorp/next-mdx-remote/releases/tag/3.0.0

## License

[Mozilla Public License Version 2.0](./LICENSE)

0 comments on commit ae39ed7

Please sign in to comment.