How To: Offline access to Vue.js documentation


If you are working with Vue.js Javascript framework to build your next generation web apps then you might be frequently visiting the Vue.js guide section (https://vuejs.org/v2/guide/) to see how certain things work in Vue.js. Most of the time you go to the Vue.js site since that is the only available option for office docs.

But, often it happens we don’t have access to internet and we have time to read something then we usually go to our saved articles, guides, books, or any other content to read. In that case if we have Vue.js guide available offline we could have luxury to read that without connecting to internet. Well, that is possible.

How to download the guide?

To download the guide for offline access all you have to do is clone the official Git repo from GitHub and perform the following steps.

  1. Clone Vue.js Git repo from GitHub https://github.com/vuejs/vuejs.org
  2. Open terminal or command prompt
  3. Go to the directory/folder where you have cloned the repo
  4. If you have npm installed that is most likely if you are a developer then run the following commands:
    1. $ npm install -g hexo-cli
      $ npm install
      $ hexo server
  5. Browse http://localhost:4000/v2/guide/ in your favorite browser.

That’s it! You have Vue.js guide available offline.

The next time you want to access your offline guide all you have to do is open terminal, go to repo directory and run hexo server command.

Why Hexo?

Vue.js guide is built using Hexo blog framework. You can read more about Hexo framework on their website https://hexo.io/

What we did is just clone the repo and ran the hexo server from the hexo-cli we installed using npm. This is not convenient as reading a PDF but still we have an option to read the guide offline.

If this helped you or if you found a better way then don’t forget to leave a comment below.

Advertisements

One thought on “How To: Offline access to Vue.js documentation

Ask J

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s