Tạo web siêu dễ với VuePress và Github Pages

23/02/2019 — @nqdai1992
1688 từ — Đọc trong 6 min

Gần đây mình có tìm hiểu cách tạo blog bằng Github Pages (GP). Mình bắt đầu bằng cách làm theo theo hướng dẫn trên trang chủ GP, và đúng là chỉ sau vài phút, bạn đã có ngay một trang web "coi cũng được". Tuy nhiên, nhìn blog thiên hạ màu mè các kiểu làm mình cũng muốn tìm hiểu cách thiết kế giao diện và trang trí cho website bắt mắt hơn, thì gặp Jekyll. Jekyll đã có sẵn hỗ trợ cho GP, mỗi tội máy tính của bạn phải có Ruby mới dùng được. Mình thì không thích cài những gì mà cả năm mới dùng tới, vả lại nếu chỉ để phục vụ mỗi việc tạo blog thì cũng không đáng. Thế là mình mò thêm các giải pháp khác và bắt gặp VuePress. Vô tình mình cũng đang làm việc với Vue, nên “sao lại không nhỉ?”

VuePress là gì?

VuePress là một sản phẩm của Evan You, tác giả của Vue, với mục đích tạo web tĩnh (static webpages). Về căn bản website xây dựng bằng VuePress là một SPA trên nền của Vue, Vue Router, và webpack. VuePress giúp bạn đơn giản hoá việc thiết lập SSR bằng Nuxt, cùng ti tỉ thứ khác.

Những tính năng chính của VuePress bao gồm:

  • Hỗ trợ Markdown ngay từ đầu
  • Cho phép xây dựng theme bằng template của Vue
  • Hỗ trợ Service Worker
  • Tích hợp sẵn Google Analytics
  • Hiển thị “Lần cập nhật gần nhất” dựa vào thông tin từ Git
  • Hỗ trợ đã ngôn ngữ

Chi tiết hơn bạn có thể xem ở đây.

Cài đặt và chạy VuePress

Để bắt đầu, bạn cài đặt VuePress bằng npm:

$ mkdir blog
$ cd blog
$ npm init
$ npm install --save vuepress

Sau đó thêm vào scripts của package.json để chạy hai lệnh devbuild.

{
  "scripts": {
    "dev": "vuepress dev",
    "build": "vuepress build"
  }
}

Chúng ta có thể kiểm tra thử quá trình cài đặt bằng cách chạy lệnh.

$ npm run dev

VuePress dev server listening at http://localhost:8080/
[18:50:15] ✔ successfully compiled.

Hãy thử truy cập vào http://localhost:8080, và kết quả là…

Lý do là vì chúng ta chưa tạo tập tin markdown đóng vai trò làm trang chủ. Theo mặc định, VuePress sẽ đọc các tập tin README.md và chuyển thành index.html tương ứng. Do đó, chúng ta sẽ tạo một file README.md ở thư mục gốc có nội dung như sau:

---
home: true
---

# Hello VuePress

VuePress sẽ tự động compile lại khi có thay đổi xảy ra trong thư mục làm việc hiện tại. Thử vào trang http://localhost:8080, chúng ta sẽ thấy không còn lỗi 404 nữa.

Thiết lập cấu hình cho VuePress

Để tuỳ chỉnh VuePress, bạn cần một file .vuepress/config.js. Lúc đó cấu trúc thư mục của bạn sẽ như thế này.

.
├─ README.md
└─ .vuepress
│  └─ config.js
└─ package.json

Trong tập tin config.js, chúng ta có thể cấu hình được các thành phần cơ bản của trang web như:

  • title: Tên website
  • description: Giới thiệu về website
  • head: Những tag sẽ được thêm vào phần HEAD của website
  • locales: Thiết lập đa ngôn ngữ
  • ga: ID của Google Analytics nếu bạn muốn tích hợp
module.exports  =  {
  title: 'Tên blog',
  description: 'Mô tả về blog',
  locales:  {
    '/vi':  {
      lang:  'vi-VN',
      title:  'Tên blog tiếng việt',
      description:  'Mô tả tiếng việt'
    },
    '/en':  {
      lang:  'en-VN',
      title:  'Tên blog tiếng anh',
      description:  'Mô tả tiếng anh'
    }
  }
}

Bạn có thể xem danh sách đầy đủ các thiết lập của VuePress ở đường dẫn này.

Mách nhỏ: Bạn cũng có thể dùng YAML (config.yml) hay TOML (config.toml) để cấu hình VuePress.

VuePress sau khi được cài đặt đã kèm theo một giao diện mặc định. Cá nhân thì mình khá thích giao diện này, nhưng tùy mỗi người sẽ có những nhu cầu thay đổi khác nhau. Để thay đổi thiết lập cho giao diện mặc định, bạn thêm vào thuộc tính themeConfig trong tập tin config.js.

module.exports  =  {
  themeConfig: {
    sidebar: 'auto' // Luôn hiển thị sidebar trong bài viết
    // Thiết lập các liên kế trên navbar
    nav: [
      { text: 'Trang Chủ', link: '/' },
      { text: 'Giới Thiệu', link: '/about/' },
      { text: 'Ehkoo', link: 'https://ehkoo.com' },
    ],
  }
}

Chi tiết hơn về các thiết lập của giao diện mặc định có thể xem ở đây.

Thêm bài viết mới

Cũng như các công cụ tạo web tĩnh khác, VuePress hỗ trợ YAML front matter, cho phép chúng ta khai báo các giá trị của một bài viết, chẳng hạn như tên bài, ngày khởi tạo, tên tác giả, tags, v.v…Phần front matter này sẽ được viết với cú pháp YAML, và đặt ở ngay đầu tập tin markdown.

Chúng ta có thể quy ước tất cả bài viết sẽ nằm trong thư mục /posts. Bạn tạo một tập tin /posts/simple-post.md có nội dung như sau:

---
title: A Simple Post
---

# A Simple Post

## Lorem ipsum

Lorem ipsum dolor sit amet, legere mnesarchum sea ad, animal utamur dolores in his, per solet diceret rationibus no. Sit et timeam accusamus rationibus, no usu labitur bonorum constituto. Has delicata percipitur no, ut sit magna nulla sadipscing. Vis ad modo scaevola, ex vix delicata theophrastus deterruisset, an fabellas sensibus sed. Vim quaestio percipitur ne, modus ipsum saperet has cu. Ne nemore aliquid incorrupte eam, quo ad civibus interpretaris, per cu urbanitas deterruisset.

## Duis paulo utamur

Duis paulo utamur eu cum, suas luptatum dignissim est at. Ad duo dicat theophrastus, diceret aliquam te vis. Quo illum putant incorrupte id. Ea melius democritum consequuntur qui, in mea dicta dicant. Tollit copiosae voluptatibus mel te. Labore feugiat cu eos, ex primis iudicabit signiferumque quo.

Natum simul dolor ut sed, ut quod rationibus referrentur mea. Zril periculis eu sit. Eos ea audiam nusquam, ex eos paulo detraxit, has partem graeci ea. Per et possim cetero laoreet. No accusam fastidii vel. At eos esse solet, mentitum convenire an eos.

### Ut corpora

Ut corpora omnesque has, eam fugit splendide eu. Ad has assum possim, augue movet denique sed an, ne pro saperet prodesset. Ex vim fugit laboramus. Te sed tibique honestatis. Mei ad albucius quaestio, epicurei sententiae cum ne, nobis probatus recusabo pri ex. Alterum dissentiet in has, sea movet putent habemus ex, duo deleniti suscipiantur ei.

### An mea

An mea meis dolor, nam summo viris nominavi eu. Wisi justo nec eu, meis omnesque nam id. Ludus dicam duo et. Ut instructior consectetuer mei. Quot complectitur ex eum, quo fugit dissentiet ei, solum ridens apeirian mei et.

Sau đó truy cập vào http://localhost:8080/posts/simple-post.html để xem kết quả. VuePress đã chuyển nội dung markdown thành HTML, đồng thời hiển thị một sidebar chứ đầu mục của các tiêu đề trong bài.

Tạo trang nội dung tĩnh

Thông thường website sẽ có những trang nội dung tĩnh, chẳng hạn như "Giới thiệu", "Liên hệ", "Cộng tác", v.v…Chúng ta có thể tạo những trang như vậy và hiển thị đường dẫn đến chúng ở navbar của website. Chẳng hạn, bạn có thể tạo tập tin /about/README.md như sau:

---
title: Giới thiệu
sidebar: false
---

# Giới thiệu

Không có gì cả

Sau đó, bạn thay đổi tập tin config.js và thêm nav vào thuộc tính themeConfig.

module.exports = {
  themeConfig: {
    nav: [
      { text: 'Trang Chủ', link: '/' },
      { text: 'Giới Thiệu', link: '/about/' },
      { text: 'Ehkoo', link: 'https://ehkoo.com' },
    ],
  }
}

Trong ví dụ ở trên, mình thêm vào đường dẫn đến trang Giới thiệu, và một đường dẫn đến website ngoài. Bạn lưu ý là đường dẫn tới các routes trong ứng dụng phải kết thúc bằng /, chẳng hạn như /about/.

Sử dụng Vue components

Một trong những điểm sáng của VuePress là cho phép bạn sử dụng các Vue components ngay trong tập tin markdown. Các components này sẽ được đặt ở thư mục .vuepress/components và chúng ta có thể sử dụng chúng ở bất cứ nơi nào. Bên trong mỗi component sẽ có một biến $page chứa các giá trị YAML front matter của tập tin markdown hiện tại. Ngoài ra còn có một biến $site, chứa các giá trị thiết lập trong config.js, cùng với một số giá trị đặc biệt khác.

Hãy thử tạo một component all-posts.vue chứa tất cả những bài viết đang có trong blog.

// .vuepress/components/all-posts.vue
<template>
  <div>
    <p v-for="post in $site.pages.filter(p => p.path.includes('/posts'))">
      <router-link :to="post.path">{{ post.title }}</router-link>
    </p>
  </div>
</template>

Sau đó chúng ta khai báo sử dụng component này trong tập tin /README.md.

---
home: true
---

# All Posts

<all-posts />

Kết quả là:

Build và xuất bản lên Github Pages

Để build website thành các tập tin HTML, bạn chạy lệnh:

$ npm run build

Các tập tin HTML kết quả sản phẩm sẽ nằm trong thư mục .vuepress/dist. Nhưng để xuất bản lên Github Pages (GP) thì bạn phải thay đổi chút xíu. Theo hướng dẫn ở đây, nếu trong repository của bạn có thư mục /docs ở branch master, GP sẽ được trỏ đến thư mục đó. Do đó chúng ta sẽ chỉnh lại tập tin config.js.

module.exports  =  {
  dest: 'docs'
}

Như vậy website được built ra sẽ nằm ở thư mục /docs thay vì .vuepress/dist. Sau đó bạn bật tính năng Github Pages cho repo bằng cách vào trang Settings - GitHub Pages - Source và chọn master branch /docs folder như hình.

Tổng kết

Trên đây mình đã trình bày sơ lược các tạo blog bằng VuePress. Mình cũng có xem qua Gastby của React, nhưng có lẽ do mình không quen nên cảm thấy khá sơ khai và có nhiều thứ phải làm lại hơn. Dù vậy, quyền quyết định ở các bạn. Công nghệ không quan trọng, quan trọng là phù hợp với mục tiêu đề ra. Với tiêu chí đơn giản, nhanh gọn và code ít, mình chọn VuePress.

Bạn có thể tham khảo mã nguồn của demo trong bài viết này tại https://github.com/ehkoo/vuepress-demo. Đừng quên thả sao nhé ;)

Bạn thích bài viết này? Đăng ký nhận Bản tin Ehkoo NGAY, để luôn được cập nhật tin tức mới nhất về thế giới front-end nhé!


Bình luận

Đăng ký bản tin

Quá lười để vào Ehkoo mỗi ngày? Không sao hết, Ehkoo sẽ gửi bài cho bạn mỗi tuần.

Đảm bảo chất lượng, hứa không bao giờ spam.