https://github.com/manovotny/extract-mdx-metadata

Extract MDX metadata without using babel or webpack loaders.
https://github.com/manovotny/extract-mdx-metadata

mdx metadata

Last synced: 3 days ago
JSON representation

Extract MDX metadata without using babel or webpack loaders.

• Host: GitHub
• URL: https://github.com/manovotny/extract-mdx-metadata
• Owner: manovotny
• License: mit
• Created: 2019-03-12T20:42:32.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-09-20T16:27:07.000Z (about 3 years ago)
• Last Synced: 2024-09-21T09:03:25.282Z (6 days ago)
• Topics: mdx, metadata
• Language: JavaScript
• Homepage:
• Size: 1.36 MB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# extract-mdx-metadata

> Extract MDX metadata without using babel or webpack loaders.

## Installation

### NPM

```

$ npm i extract-mdx-metadata

```

### Yarn

```

$ yarn add extract-mdx-metadata

```

## Usage

Say we have the following file, `example.mdx`:

```

import something from 'something';

export const meta = {

    prop: 'value',

};

# Title

Content.

```

And our script, `example.js`, looks as follows:

```js

const fs = require('fs');

const extractMdxMeta = require('extract-mdx-metadata');

(async () => {

    const path = 'example/example.mdx';

    const content = fs.readFileSync(path);

    const meta = await extractMdxMeta(content);

    console.log('meta', meta);

})();

```

Now, running `node example` yields:

```

meta {

    prop: 'value'

};

```

You can try this yourself by downloading or cloning the project, installing dependencies, and running `yarn example`.

## API

### `extractMdxMeta(content, [options])`

Parses content and returns the metadata object.

#### options

Type: `Object`

##### `defaultReturnValue`

Type: `*`

Default: `{}` (empty `Object`)

The value returned if the content does not contain any metadata.

## License

MIT © [Michael Novotny](https://manovotny.com)