Nội dung

Nội dung

Phần tiêu đề

Ở đầu mỗi trang đều có phần header này để hiển thị tiêu đề và xác định điều hướng ở bên Navigation panel bên trái trang.

  • title = "Viết nội dung": Để nội dung ngắn gọn súc tích để vừa 1 dòng ở bên Navigation panel bên trái.
  • chapter = false : Để mặc định là false. Title ở trên cũng sẽ hiển thị là h1 ở trong bài viết.
  • weiht: Dùng để sắp xếp index của tiêu đề
  • pre = "<b>2. </b>" : Đây là đánh số cho trang hiển thị ở Navigation panel bên trái.
---
title : "Viết nội dung"
date :  "`r Sys.Date()`" 
weight : 2
chapter : false
pre : " <b> 2. </b> "
---

Phần heading

  • Chúng ta sẽ thống nhất việc dùng tiêu đề cho các section trong 1 trang sẽ sử dụng h4 (####).

Phần Table of Contents (TOC)

  1. Sau khi viết xong nội dung (hoặc liệt kê xong các Heading của 1 trang), chúng ta có thể xây dựng Table of Contents (TOC) tự động bằng plug-in.

  2. Sử dụng tổ hợp phím Ctrl + Shift + P sau đó gõ vào Create Table of Contents rồi chọn lựa chọn của plug-in Markdown All in One. Enter.

Chúng ta sẽ có một cái TOC như sau:

Nội dung:
- [**Cách viết một Lab Guide**](#cách-viết-một-lab-guide)
	- [**I. Phần 1: Chuẩn bị**](#i-phần-1-chuẩn-bị)
	- [II. **Phần 2: Nội dung**](#ii-phần-2-nội-dung)
	- [1. Cấu trúc file](#1-cấu-trúc-file)
			- [**Thư mục *content***](#thư-mục-content)
			- [**Thư mục *static/images***](#thư-mục-staticimages)
			- [**Thư mục *public***](#thư-mục-public)
	- [2. Nội dung](#2-nội-dung)
			- [**Phần tiêu đề**](#phần-tiêu-đề)
			- [**Phần heading**](#phần-heading)
			- [**Phần Table of Contents (TOC)**](#phần-table-of-contents-toc)
			- [**Phần ghi chú**](#phần-ghi-chú)
			- [**Phần tập tin đính kèm**](#phần-tập-tin-đính-kèm)
			- [**Phần vẽ bảng**](#phần-vẽ-bảng)
			- [**Phần hình ảnh**](#phần-hình-ảnh)
		- [**Update config.toml**](#update-configtoml)

Chèn icon trong các phần giới thiệu

  1. Ta sử dụng bộ icon tải về từ AWS tại đây
  2. Thực hiện lệnh chèn như sau:
{< figure src="../images/fcj.png" title="First Cloud Journey" width=150pc >}

Phần ghi chú

  1. Trong bài viết có thể sẽ có các đoạn cần làm nổi bật lên như Ghi chú, Cảnh báo,… thì sẽ dùng shortcode theo hướng dẫn tại đây

  2. Ghi chú Note. Xem thêm tại Note

Đây là Note

  1. Ghi chú Info

Đây là Info

  1. Ghi chú Tip

Đây là Tip

  1. Ghi chú Warning

Đây là Warning

Phần tập tin đính kèm

  1. Phần này sẽ thực hiện theo hướng dẫn tại đây

  2. Vị trí đặt tập tin sẽ là trong thư mục tương ứng với tên trang md. như sau:

  • _index.md —> _index.files
  • _index.vi.md —> _index.vi.files

Nghĩa là nếu có nhiều ngôn ngữ thì mỗi ngôn ngữ 1 thư mục như vậy cho 1 trang.

  1. Sử dụng shortcode sau để tạo phần đính kèm:

  • title : Tiêu đề phần đính kèm

  • pattern : Xác định các tập tin được hiện ra trong box (có thể để tên tập tin hoặc pattern để xác định theo đuôi)

  • Ví dụ lọc tập tin Dockerfile:

{{%<attachments title="Dockerfile" pattern="Dockerfile"/%}}
  • Ví dụ lọc tập tin theo đuôi:
{{%attachments title="Build Scripts" pattern=".*(ps1|sh)"/%}}

Phần vẽ bảng

Để đơn giản hóa việc vẽ bảng, người viết thường sử dụng công cụ Tables Generator

  1. Truy cập tới trang.
  2. Nhập nội dung xong bấm Generate rồi Copy to clipboard.
  3. Xong vô đây Paste vào thôi.

Phần hình ảnh

  1. Phần mềm chụp màn hình khuyên dùng: SnagIt (2019/2020)

  2. Thiết kế hình ảnh:

Để tạo sự đồng nhất và dễ hiểu cho người xem, chúng ta định hình ra một chuẩn chung như sau:

  • Về Screenshot Console:
  • Trình duyệt: Chrome tắt Bookmark bar (khuyên dùng)
  • Zoom: Mặc định không zoom in (100%)
  • Độ phân giải màn hình: FullHD (1920 x 1080)
  • Định dạng: PNG (Khuyên dùng)
  • Về Font chữ ghi trên hình:
  • Font: Arial Black
  • Size: 18
  • Không bật Shadow.
  • Về Khung đánh dấu khu vực cần chú ý:
    • Màu: Trùng với màu chữ ghi chú
    • Độ dày (Thickness): 1 px
    • Độ mờ (Opacity): 100%

Update config.toml

[Languages.en]
title = "How to Write a Lab Guide"
weight = 1
languageName = "English"
	
[Languages.vi]
title = "Cách viết một Lab Guide"
weight = 2
languageName = "Tiếng Việt"