Docz: How to configure menu on doczrc.js

Created on 2 Nov 2018  路  3Comments  路  Source: doczjs/docz

Question

Description
It seems that #322 was released but there is barely any documentation on usage. If you were trying to look for how to order the docs like I was, you might end up in a couple issues that ultimately leads you to this page: http://feedback.docz.site/roadmap/p/managing-menu-order-on-default-theme

There is an image on that page for how to configure it but it doesn't seem to work.
image

Looking at #322 there is an example on there given by @mpivaa
Like

export default {
  menu: [
    'Getting Started',
    {
      name: 'Components',
      docs: [
        'Alerts',
        'Button',
        ...
      ],
    }
  ]
}

I have not been able to get that to work either.
It's also not clear, the strings provided in the docs array of the object, is that the name of the mdx file? Is that the name property added to the top of the file??
Like

name: Button
---

Could someone clarify with examples? Or even better add it to the official docs?

At the moment for me configuration like this:

menu: [
    'Introduction',
    {
      name: 'Getting Started',
      docs: [
        'Button'
      ],
    }
  ]

just comes out as a flat structure:
image

Thanks for your time.

Most helpful comment

@pedronauck can we keep this issue open until it is officially documented? The intent of the issue to begin with is that a user trying to figure out how to do this is left with nothing but to dig through these various wrong examples... having it officially documented would open it up for more folks to know it is supported and to test it with the given docs

All 3 comments

You can see how configure menu in the release link. I didn't have time to update docs yet 馃槙

I'm still having trouble with menu order feature. @pedronauck is there an example of this being implemented successfully?

I've tried every method out hear and still no luck.

@pedronauck can we keep this issue open until it is officially documented? The intent of the issue to begin with is that a user trying to figure out how to do this is left with nothing but to dig through these various wrong examples... having it officially documented would open it up for more folks to know it is supported and to test it with the given docs

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fenbka picture fenbka  路  3Comments

koddr picture koddr  路  3Comments

tsnolan23 picture tsnolan23  路  3Comments

brunolemos picture brunolemos  路  3Comments

kachkaev picture kachkaev  路  3Comments