Skip to content

Commit

Permalink
Updated readme with an example of overriding default Bootstrap 4 classes
Browse files Browse the repository at this point in the history
  • Loading branch information
theianjohnson committed Jul 19, 2019
1 parent 5810800 commit a7b9ec4
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,37 @@ An automatic, living Vue component documenter - yes - a component that documents
<template>
<div>
// Initially works with Bootstrap 4 classes
<vue-documenter>
<some-component></some-component>
<another-component></another-component>
</vue-documenter>
// But you can also remap your own (these are defaults)
/*
<vue-documenter
:css-override-classes="{
badgeDeprecated: 'badge badge-warning',
badgeOptional: 'badge badge-secondary',
badgeRequired: 'badge badge-danger',
card: 'card card-body',
componentsColumn: 'col-sm-9',
componentsColumnComponent: 'card card-body',
componentsColumnComponentTableWrapper: 'table-responsive',
componentsColumnComponentTable: 'table table-striped',
container: 'container-fluid',
exampleMinimal: 'col-sm-6',
exampleFull: 'col-sm-6',
instructions: 'alert alert-info',
tableOfContentsColumn: 'col-sm-3',
tableOfContentsColumnList: '',
row: 'row'
}"
>
<some-component></some-component>
<another-component></another-component>
</vue-documenter>
*/
</div>
</template>
<script>
Expand Down

0 comments on commit a7b9ec4

Please sign in to comment.