💡 A draft for alternative vuetify docs with a completely restructured and redesigned layout & navigation. This is neither fully designed, nor responsive as it's just a poc. It uses the same routing-structure as the original to not affect SEO and create broken links. A lot of sites are moved to a new location to declutter the menu. It includes all sites (except the labs).
This project contains a re-work of the vuetifyjs docs showing structural reworks. With the re-structured navigation things will be easier to find and the menu + toolbar end up less cluttered.
The following points should be optimized in the docs and are already included in this poc, or should be added:
- Homepage:
- Add more information about the framework, show off some components and store products (starter templates)
- Link to docs in Nav
- Header
- Declutter Toolbar: way too many submenus. Move Languages and theme-toggle into the settings drawer
- New version selection
- Change search-Short code to cmd+k / strg+k ("new" docs standard in the vue universe and a lot more)
- Rename
shoptotemplates(people literally LOVE great templates, just look at talwindUI) - Shrink on scroll
- Full menu rework(remove duplicate entries and different naming for the same thing, move stuff to different subpages)
- Sidebar
- Settings sidebar: cleanup design, include more stuff like Language switch
- Docs
- Point out the differences between components (e.g Ap-Bar vs Toolbar)
- Remove grouping in component-list (e.g Forms)
- Split component-pages in subpages:
- Overview
- Usage
- API (The integration of the subcomponents-API still needs a better solution. Alternative: Don't display the component subpages as tabs - instead use sub-list in the sidebar including the APIs. Draft: play.vuetifyjs.com)
# yarn
yarn
# npm
npm install
# pnpm
pnpm install
# yarn
yarn dev
# npm
npm run dev
# pnpm
pnpm dev
# yarn
yarn build
# npm
npm run build
# pnpm
pnpm build