A tool to improve your Vuejs project documentation.
$ npm install @luaguillande/luadoc
$ npm i marker
Exemple to create a local route (doesn't work in production) in Laravel.
if (App::environment('local')) {
Route::get('doc', function () {
View::addNamespace('Folder', '../node_modules/@luaguillande/luadoc/doc');
return View::make('Folder::doc');
});
}
Exemplo using webpack:
mix.js('node_modules/@luaguillande/luadoc/doc/luadoc.js', 'public/js')
cp node_modules/@luaguillande/luadoc/doc/Components.js public
import CompA from '../resources/js/components/CompA.vue';
import CompB from '../resources/js/components/CompB.vue';
export {
CompA,
CompB
}
export default{
name: 'comp-a',
description: `This \`comp-a\` is amazing, you should _check_ it out.`,
token: `<comp-a label='foo'></comp-a>`,
}
img: "imgs/doc/compa.png",
slots:[
{
name: 'lol',
note: "a label to be appended after the checkbox"
}
],
usage:[
{
url: '/',
calledBy:['welcome.blade.php', 'App.vue']
},
],
props: {
label: {
type: String,
default: '',
note: "a label to be appended after the checkbox"
},
color: {
type: String,
default: 'blue',
note: "a color for checkbox"
}
}
@luaguillande - 31solutions.com