-
-
Notifications
You must be signed in to change notification settings - Fork 696
Docs: add vuepress documentation #534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
# Conflicts: # README.md
0e99261 to
116eb34
Compare
@michalsnik your package tree is broken, remove node_modules, package-lock and npm i again
its bug with npm
Sounds like you have encountered this npm's bug eslint/eslint#11018.
Please try to remove package-lock.json and node_modules then re-install all.
Weird @armano2. First thing I did was to remove node_modules and clean cache, but it didn't help. Now I updated this branch on my other computer and it works 🤔
I think that's it! And since it's all about documentation there's no better person to mention here, but @chrisvfritz would you give it a look? :) I think It's the final part before releasing v5
@michalsnik looks like fileInfo data is not updated when # title is present
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice work on this! A few, mostly nitpicky comments:
-
The negative top margin on
blockquotes is looking a little strange directly underneathh1s. -
In the interactive code examples, I'm seeing:
[ESLint] Parsing error: acorn.Parser.extend is not a function (FATAL)
-
The bottom padding of the interactive code examples seems a little excessive and I think might also be increasing a little with each line in the initial code.
-
This is definitely a nitpick and something we can skip for now, but is there any chance we could get the interactive code examples styled more similarly to the other code examples?
- arcon.Parser error: Docs: add vuepress documentation #534 (comment)
- coloring is possible and we should do it, currently we are using html schema and we should define one for vue files (it's not defined in editor)
if you are going to have issues with arcon.Parse you can preview it here: https://armano2.github.io/eslint-plugin-vue/
@armano2 Thanks! Apologies for missing that comment in the above thread. 😅 I just checked out the demo you linked to and the interactive editor looks fantastic. 😻
I made the negative margin on purpose @chrisvfritz. Do you think we should remove it?
image
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about using something like this instead:
https://github.com/eldarlabs/ghpages-deploy-script/blob/master/scripts/deploy-ghpages.sh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are the benefits of using it instead? I copied deploy script from the official Vuepress documentation :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
instead of making one commit and force pushing it over and over again, its adding changes only
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, now or never. Time to ship it. It already grew soo much.
This is working in progress.
I'm trying to make the documentation with VuePress.
You can review it with:
npm installnpm run docs:watchIt will be similar to https://mysticatea.github.io/eslint-plugin-es/
Pros:
Cons: