awesome-vue icon indicating copy to clipboard operation
awesome-vue copied to clipboard

Refactoring awesome-vue structure?

Open mazipan opened this issue 6 years ago • 5 comments

It's very hard to maintain file Readme.md with very long contents. Can we plan to refactoring this repo to be more easier to be added or updated in the future?

The easiest way to refactoring in my opinion is to split into each .md file for each categories in awesome-vue. But for implement this things we need to freeze any PR maybe for few days.

Any comments or insight for this opinion?

mazipan avatar Oct 02 '18 15:10 mazipan

@mazipan And how are we going to show all the splited .md files as one?

DannyFeliz avatar Oct 02 '18 16:10 DannyFeliz

Just show the categories in readme.md, each categories will link to the .md file.

Or anybody have any other ideas?

mazipan avatar Oct 02 '18 22:10 mazipan

@mazipan Yes but know this repo won't be "searchable" by default. As you can see basically all the awesome- repos are like this, the idea is having everything on one page where you can find quickly what you need.

DannyFeliz avatar Oct 03 '18 02:10 DannyFeliz

I have a repo that I try to keep up to date with changes in the official repo. It has some basic categorization split into multiple markdown files.

https://awesome-vue.js.org/

rmjordas avatar Oct 03 '18 04:10 rmjordas

@mazipan I don’t think it’s a good idea to search, given that you can’t always find wherever you are.

Scrum avatar Mar 13 '20 15:03 Scrum