Skip to content

Commit

Permalink
fix link
Browse files Browse the repository at this point in the history
  • Loading branch information
souporserious committed Apr 23, 2022
1 parent 4b59c16 commit a24a51a
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions packages/mdx-to-md/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<!--- This README was auto-generated from "packages/mdx-to-md/src/README.mdx" using "yarn build" -->
<!--- This README was auto-generated from "packages/mdx-to-md/src/README.mdx" using "yarn build" -->

# mdx-to-md
# mdx-to-md

Convert MDX to Markdown.
Convert MDX to Markdown.

## Why?

This library is most useful for generating README.md files [like the one you're reading](%28/packages/mdx-to-md%29).
This library is most useful for generating README.md files [like the one you're reading](/packages/mdx-to-md/src/README.mdx).

## Install

```bash
yarn add mdx-to-md

```

```bash
npm install mdx-to-md

```

## Usage
Expand All @@ -28,6 +30,7 @@ import { Text } from "@chakra-ui/react"
# Hello World

<Text color="tomato">Compile static MDX content to Markdown 😎</Text>

```

And convert it to Markdown:
Expand All @@ -43,4 +46,5 @@ const readme = `<!--- ${banner} --> \n\n ${markdown}`
await writeFile("README.md", readme)

console.log("📝 Converted README.mdx -> README.md")
```

```

0 comments on commit a24a51a

Please sign in to comment.