Improve the examples format on the README file - #67

@ali-turki ali-turki commented Feb 28, 2018

Copy link

Copy Markdown

improved formatting added syntax highlighted to examples snippets, I've not changed any description or even a word just formatting.

ali-turki added 4 commits

February 28, 2018 14:36


 Update README.md

4bd7ae6


 Update README.md

cdae04d


 improved formatting, syntax highlighted

d6ed8c8

improved code formatting and added syntax highlighted without changing any description or even word.


 js syntax highlighted to examples snippet

f44dc64

jamiecarter7

jamiecarter7 suggested changes

Mar 3, 2018

@jamiecarter7 jamiecarter7 left a comment

Copy link

Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

var loadingTask = pdf.createLoadingTask('https://cdn.mozilla.net/pdfjs/tracemonkey.pdf');

should read:

var loadingTask = VuePdf.createLoadingTask('https://cdn.mozilla.net/pdfjs/tracemonkey.pdf');


 typo fixes.

ddb8d8e

ali-turki commented Mar 3, 2018

Copy link

Copy Markdown

Author

Thanks, it's done.

FranckFreiburger reviewed

README.md Outdated

```js

<vue-pdf src="./static/relativity.pdf" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good, just for the record: Self-closing components

FranckFreiburger reviewed

README.md

this.numPages = pdf.numPages;

});

components: {

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move "components" at the top (https://vuejs.org/v2/style-guide/#Component-instance-options-order-recommended)

FranckFreiburger reviewed

README.md Outdated

});

}

components: {

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"components" =>top

FranckFreiburger reviewed

README.md

#### @error <sup>Object<sup>

Triggered when an error occurred.

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to avoid line-break for the "Listen to" column ?

FranckFreiburger reviewed

README.md Outdated

<vue-pdf

src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf"

@num-pages="pageCount = $event"

@page-loaded="currentPage = $event" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move /> to the newt line, aligned with <vue-pdf

FranckFreiburger reviewed

README.md Outdated

:key="i"

:src="src"

:page="i"

style="display: inline-block; width: 25%" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/> => next line

FranckFreiburger reviewed

README.md Outdated

</button>

<vue-pdf

ref="myPdfComponent"

src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/> => next line

FranckFreiburger reviewed

README.md Outdated

<button @click="logContent">log content</button>

<vue-pdf

ref="myPdfComponent"

src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/> => next line

FranckFreiburger reviewed

README.md Outdated

@password="password"

@progress="loadedRatio = $event"

@error="error"

@num-pages="numPages = $event" />

@FranckFreiburger FranckFreiburger Mar 14, 2018

Copy link

Copy Markdown

Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/> => next line

ali-turki added 2 commits

March 14, 2018 22:20


 improved self-closing components formatting

f34342f


 improved formatting

d262d70

* move components closing tag to a new line.
* move components object to the top.