Skip to content

Hướng dẫn sử dụng MkDocs (Markdown Documents)

Viết bài mới / Chỉnh sửa bài cũ

Viết bài trực tiếp trên giao diện của GitLab, theo các bước:

  1. Vào đường dẫn của GitLab, repository: AILab_Docs

  2. Checkout branch static_deployed.

  3. Thêm mới tệp tin .md (Markdown) mới vào folder và phân cấp thư mục tương ứng.

  4. Viết bài trực tiếp trên GitLab sử dụng cú pháp Markdown ( hướng dẫn cú pháp Markdown) Trong quá trình viết, sử dụng tab Preview để xem trước bài viết và chỉnh sửa để tránh lỗi hiển thị. Nếu cần tải lên hình ảnh trong quá trình viết bài, tạo folder img/ đồng cấp với file .md đang viết và tải ảnh lên.

    Ví dụ: 

    docs/
    markdown-syntax.md 
    img/  ==> Tạo folder img đồng cấp với file markdown sử dụng ảnh, ví dụ đây là file markdown-syntax.md thì cần tạo folder img/ đồng cấp. 
        markdown-guide-og.jpg
    Vue.JS 
        introduction.md 
        installation.md 
        img/ ==> Nếu file installation.md sử dụng ảnh tải lên, thì phải tạo folder img/ đồng cấp với nó (nằm trong folder Vue.JS) và tải ảnh cần dùng lên đây. 
            image_001.jpg 
            image_002.jpg

  5. Sau khi kiểm tra và hài lòng về bài viết, chọn button Commit changes để lưu bài viết.

Đồng bộ với website quản lý tài liệu (dành cho luồng chưa có CI/CD)

Section này dành cho quản trị viên trang MkDocs

Hiện nay, MkDocs đang được triển khai qua docker, data được lưu lại và đồng bộ thông qua git.

  1. Truy cập vào folder repository của AILab_Docs đã clone trên server.
  2. Checkout branch (static_deployed) bằng lệnh: 
    git checkout -b static_deployed
  3. Pull bài viết mới từ GitLab về sử dụng lệnh: 
    git pull

Sau khi pull, website sẽ tự động cập nhật giống như nội dung trên GitLab

Đồng bộ với website quản lý tài liệu (dành cho luồng đã có CI/CD)

Section này dành cho quản trị viên trang MkDocs

Sau khi đã triển khai CI / CD, khi có bài viết mới được thêm vào, gitlab-runner sẽ tự động kéo code mới về và tự deploy lại, không có thao tác nào cần được thực hiện.

Hỗ trợ

Liên hệ tranhamduong@siu.edu.vn để được hỗ trợ kĩ thuật trong quá trình sử dụng MkDocs.