docz
docz copied to clipboard
Docz only showing my readme files, not the .MDX
Question
I've followed the basic instructions to install the docz and when I enter @ port:3001 I can only see the README files from my project
I don't receive any errors at the terminal or console browser, so I have no idea what's happening, what I know is I have created one Button.mdx file and the file is not being displayed
Button.mdx File
---
name: Button
route: /
---
import { Playground, Props } from 'docz'
import Button from './Index'
# Button
<Props of={Button} />
## Basic usage
<Playground>
<Button type="submit" text="click me" />
</Playground>
You have to add the following code in your doczrc.js
//doczrc.js
export default {
files: '**/*.{markdown,mdx}',
ignore: ['README.md', 'CONTRIBUTING.md'],
src: './src',
};
To customize your project configuration you can use doczrc.js, more info here