Improve the examples format on the README file #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
improved code formatting and added syntax highlighted without changing any description or even word.
jamiecarter7
suggested changes
Mar 3, 2018
There was a problem hiding this comment.
var loadingTask = pdf.createLoadingTask('https://cdn.mozilla.net/pdfjs/tracemonkey.pdf');
should read:
var loadingTask = VuePdf.createLoadingTask('https://cdn.mozilla.net/pdfjs/tracemonkey.pdf');
|
Thanks, it's done. |
README.md
Outdated
| <template> | ||
| <pdf src="./static/relativity.pdf"></pdf> | ||
| <vue-pdf src="./static/relativity.pdf" /> |
There was a problem hiding this comment.
good, just for the record: Self-closing components
| this.numPages = pdf.numPages; | ||
| }); | ||
| }, | ||
| components: { |
There was a problem hiding this comment.
please move "components" at the top (https://vuejs.org/v2/style-guide/#Component-instance-options-order-recommended)
README.md
Outdated
| }); | ||
| } | ||
| }, | ||
| components: { |
| #### @error <sup>Object<sup> | ||
| Triggered when an error occurred. | ||
|
|
||
| |Name|Attributes|Listen to|Description| |
There was a problem hiding this comment.
is it possible to avoid line-break for the "Listen to" column ?
README.md
Outdated
| <vue-pdf | ||
| src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf" | ||
| @num-pages="pageCount = $event" | ||
| @page-loaded="currentPage = $event" /> |
There was a problem hiding this comment.
please move /> to the newt line, aligned with <vue-pdf
README.md
Outdated
| :key="i" | ||
| :src="src" | ||
| :page="i" | ||
| style="display: inline-block; width: 25%" /> |
README.md
Outdated
| </button> | ||
| <vue-pdf | ||
| ref="myPdfComponent" | ||
| src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf" /> |
README.md
Outdated
| <button @click="logContent">log content</button> | ||
| <vue-pdf | ||
| ref="myPdfComponent" | ||
| src="https://cdn.mozilla.net/pdfjs/tracemonkey.pdf" /> |
README.md
Outdated
| @password="password" | ||
| @progress="loadedRatio = $event" | ||
| @error="error" | ||
| @num-pages="numPages = $event" /> |
* move components closing tag to a new line. * move components object to the top.
|
@FranckFreiburger almost all are done. |
Repository owner
deleted a comment from
CristinaGuan
Oct 15, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
improved formatting added syntax highlighted to examples snippets, I've not changed any description or even a word just formatting.