30/09/2018, 16:40
Front Matter - Định nghĩa tiêu đề, mô tả và các thông tin cần thiết cho Wiki
Sau 1 hồi chơi thử với API của Discourse thì em nghĩ viết wiki mình cần tuân theo 1 quy tắc nào đó để cho dễ dàng trong việc sync giữa Github và Forum. Tức là phải tiêu đề, tags, … đều được đọc từ file markdown wiki, không phải tạo bằng tay (trong vài version tiếp theo).
Nguyên tắc em đề ra là dùng ngay Jekyllrb Front Matter.
Trên đầu mỗi file sẽ có 1 cấu trúc thế này:
---
title: "wiki's title here"
tags: tag1, tag2, tag ....
more-attribute: attribute's content
---
Bất cứ wiki nào sai guide line này sẽ không được build
#Lợi ích:
- Người ngoài nhìn vào source trên GIthub cũng biết được nội dung
- Không phải invent cấu trúc mới
- Vào một ngày đẹp trời, chúng ta không thích đặt wiki ở đây thì việc host trên github cũng rất dễ dàng (đây chỉ là ví dụ )
@ltd
Bài liên quan
