Eslint-plugin-vue: #534 Broke documentation formating

Created on 4 Dec 2018 · 7Comments · Source: vuejs/eslint-plugin-vue

What did you expect to happen?

```This rule requires default value to be set for each props that are not marked asrequired(exceptBoolean` props).

<script>
````


**What actually happened?**
<!-- Please include the actual, raw output from ESLint. -->

````
This rule requires default value to be set for each props that are not marked as `required` (except `Boolean` props).

<eslint-code-block :rules="{'vue/require-default-prop': ['error']}">

All 7 comments

Github is not handling this correctly:

https://vuejs.github.io/eslint-plugin-vue/rules/require-prop-types.html

armano2 on 4 Dec 2018

Ah I see.. the markdown is meant for vuepress. ok.

I arrived to the link via Google search "require prop type vue" > https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/require-prop-types.md

So this issue is irrelavant?

amoshydra on 4 Dec 2018

If we put a blank line before and after the code block, github seems to handle it correctly.

before:
https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/attribute-hyphenation.md
after:
https://github.com/vuejs/eslint-plugin-vue/blob/patch-appearance-with-github/docs/rules/attribute-hyphenation.md
compare:
https://github.com/vuejs/eslint-plugin-vue/compare/master...patch-appearance-with-github

I think that we need to make this fix if we need to make it available from markdown.
What do you think?

ota-meshi on 5 Dec 2018

then we will have to update https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/.vuepress/components/eslint-code-block.vue to trim new line symbols

armano2 on 5 Dec 2018

https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/.vuepress/components/eslint-code-block.vue#L90

I think that it has already been trimmed, but I may misunderstood because I do not know the details.

ota-meshi on 5 Dec 2018

👍1

yes you are correct :>

armano2 on 5 Dec 2018

👍1

Any progress being made on this? All examples in the Github repo appears to be broken, and the vue ui ESLint configuration page with the "More info" links are pointing directly to the github repo, so everyone is seeing broken formatting when they click the links.

If no one is going to fix it then at least link to the vuejs.github.io site that has proper formatting.