remark-mdx-react-docgen-typescript
v1.0.1
Published
remark plugin to support react-docgen-typescript in MDX
Downloads
9,327
Readme
remark-mdx-react-docgen-typescript
📝 A mdx plugin to extract a react component documentation using react-docgen-typescript
Installation
npm install -D remark-directive remark-mdx-react-docgen-typescript
Setup
import remarkReactDocgen from 'remark-mdx-react-docgen-typescript';
// or
// const remarkReactDocgen = require('remark-mdx-react-docgen-typescript').default;
See Using plugins for more instructions in the official documentation.
Usage
For example, given a file named example.mdx with the following contents:
::component-docs{file="./Component.tsx"}
The following script:
import { readFile } from 'node:fs/promises';
import { compile } from '@mdx-js/mdx';
import remarkDirective from 'remark-directive';
import remarkReactDocgen from 'remark-mdx-react-docgen-typescript';
const { contents } = await compile(await readFile('example.mdx'), {
jsx: true,
remarkPlugins: [remarkDirective, remarkReactDocgen],
});
console.log(contents);
Roughly yields:
export default function MDXContent() {
return <ComponentDocs
propsData={[{
"tags": {},
"filePath": "${cwd}/__fixtures__/Component.tsx",
"description": "",
"displayName": "Component",
"methods": [],
"props": {...}
...
}]}
/>
}
You may use @mdx-js/react
to define the component for ComponentDocs
tag name:
import { MDXProvider } from '@mdx-js/react';
import ComponentDocs from './ComponentDocs';
// ^-- Assumes an integration is used to compile MDX to JS, such as
// `@mdx-js/esbuild`, `@mdx-js/loader`, `@mdx-js/node-loader`, or
// `@mdx-js/rollup`, and that it is configured with
// `options.providerImportSource: '@mdx-js/react'`.
/** @type {import('mdx/types.js').MDXComponents} */
const components = {
ComponentDocs,
};
console.log(
<MDXProvider components={components}>
<Post />
</MDXProvider>
);
The file path is relative to the markdown file path. You can use <rootDir>
at the start of the path to import files relatively from the rootDir:
::component-docs{file="<rootDir>/Component.tsx"}
You may also specify additional attributes that will be forwarded as props to ComponentDocs component:
::component-docs{file="./Component.tsx" extraProp="value"}
Options
componentName: string
: The name of tag/component this plugin will use in JSX. Defaults toComponentDocs
.directiveName: string
: The directive name. Defaults tocomponent-docs
.fileAttributeName: string
: The attribute name for file path. Defaults tofile
.rootDir: string
: Change what<rootDir>
refers to. Defaults toprocess.cwd()
.reactDocGenOptions: object
: Options forreact-docgen-typescript
.
Testing
After installing dependencies with npm install
, the tests can be run with: npm test
License
Rippling People Center Inc. Apache 2.0