docz icon indicating copy to clipboard operation
docz copied to clipboard

Docz only showing my readme files, not the .MDX

Open yuripramos opened this issue 5 years ago • 1 comments

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>

yuripramos avatar Jan 19 '21 20:01 yuripramos

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

MartinGK avatar Mar 09 '21 00:03 MartinGK