Skip to content
A visualization of relevant files for vue repo, along with notes
Branch: master
Clone or download
Latest commit 20cd719 Sep 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs update docs Sep 10, 2018
public update to vue docs styling Sep 5, 2018
src fix arrow placement Sep 10, 2018
.babelrc initial commit Apr 7, 2018
.gitignore make a real readme, gitignore Apr 8, 2018
.postcssrc initial commit Apr 7, 2018
LICENSE Initial commit Apr 7, 2018
README.md clarify pieces in readme Sep 10, 2018
package.json work on nav Sep 6, 2018
yarn.lock work on nav Sep 6, 2018

README.md

Vue Core Directory Visualization

🎋 Often when we're excited about contributing to a project, it takes a little while to understand the codebase even before we get started. It's estimated that developers spend 70% of their time reading code and only 30% writing. This project documents how Vue.js is set up with special notes taken from a Vue core meeting with Evan You. This should help guide people through the directory structure and give context to how and why things are set up the way that they are so that they can get set up to contribute as soon as possible.

Shows the whole Vue.js repo directory structure, with only the sections with notes shown initially. Any files that we have more info on have a note (exposed on hover). All notes and open directories are in the Vuex store.

demo-image

🎋 Demo site! https://sdras.github.io/vue-directory-tree/

When I first created this, I wrote this bit of code to create the tree.

🎋 After it was done, I thought it might be best for everyone to create a CLI tool to generate this kind of documentation. You can find this project and use it here: Project-Explorer

yarn
yarn serve
You can’t perform that action at this time.