[Feature] Added VuePress for documentation

Zulko / eagle.js

A hackable slideshow framework built with Vue.js

https://zulko.github.io/eaglejs-demo/

ISC License

4.08k stars 223 forks source link

[Feature] Added VuePress for documentation #99

Open errajswami opened 4 years ago

errajswami commented 4 years ago

Did basic setup for documentation https://errajswami.github.io/eagle.js/

There is a lot of scope for improvements, it is a just first step towards it.

Can create a workflow for automatically publishing document on merge.
Pages cab separated at its own page. Right now everything is at single page.

errajswami commented 4 years ago

@Zulko Would you like to look at this?

christian-nils commented 4 years ago

I personally like it very much. Hopefully @yaodingyd will accept the PR.

Zulko commented 4 years ago

Sorry for the delay. Thanks a lot for this that looks really good!! The one thing I am not sure I understand is the deploy.sh which, how is it used? Does it commit the built docs to master? Could you also update the repo url in that file?

errajswami commented 3 years ago

https://vuepress.vuejs.org/guide/deploy.html @Zulko Can you please have a look at this ^. We can discuss more if you want. (Sorry for delay)

errajswami commented 3 years ago

@Zulko We can set on which branch we have to push the build. and the same branch we can use for Github pages.

Also, the current pull request does not include in workflow automation for deployment. We will have to work together for that.

prashantswami commented 3 years ago

@Zulko what is holding up to get this in?