search

nodegui / vue-nodegui

Build performant, native and cross-platform desktop applications with native Vue + powerful CSS like styling.🚀
https://vue.nodegui.org
MIT License
817 stars 28 forks source link

Write script to move autogenerated sidebar content to API.widgets from the Interfaces tab #25

Closed shubhamzanwar closed 4 years ago

shubhamzanwar commented 4 years ago

When you run npm run docs, TypeDoc automatically created a new "Interfaces" key in the sidebar. As a solution to this issue, we would need to write a script to move contents from here to the "Api" section.

michaeltintiuc commented 4 years ago

@shubhamzanwar I'd be happy to lend a hand with this issue

shubhamzanwar commented 4 years ago

Go for it 🤘🏽 You can check out nodegui to see how it's being fixed there. Should give a basic idea to get started :D

Assigning this to you. If you need some help, drop a message here :D

michaeltintiuc commented 4 years ago

@shubhamzanwar it seems to me that Widgets and Interfaces arrays are identical, do you want to keep one or the other?

shubhamzanwar commented 4 years ago

Everytime TypeDoc runs, it generates the Interfaces array. We want to replace the api.widgets array with the Interfaces array and then remove the Interfaces array.

michaeltintiuc commented 4 years ago

This is what the generated website API tab looks like with the above PR image