Safe You

Hướng dẫn cài đặt, sử dụng và phát triển Safe You.

Tài liệu

Đây là mã nguồn của tài liệu cho Safe You, được lưu trữ tại safeyou-docs.github.io, sử dụng Mkdocs Material.

(back to top)

Hướng dẫn cài đặt

Đảm bảo rằng bạn đang ở thư mục gốc để có thể cài đặt các gói cần thiết khi phát triển tài liệu.

Tải mã nguồn từ Github:

git clone git@github.com:UTE-SafeYou/safeyou-docs.git

Chuyển vào thư mục mã nguồn:

cd safeyou-docs

Yêu cầu hệ thống

• Python 3.8+
• Mkdocs Material

Cài đặt

1. Cài đặt mkdocs và mkdocs-material:

pip install mkdocs mkdocs-material

mkdocs --version
mkdocs, version 1.1.2 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)

2. Chạy server để xem trước tài liệu:

mkdocs serve

3. Truy cập vào địa chỉ http://localhost:8000 để tài liệu.

4. Chỉnh sửa tài liệu và xem trước kết quả.

Bạn có thể đọc thêm về cách sử dụng mkdocs tại đây. Và mkdocs-material tại đây.

(back to top)

License

Tuân thủ theo giấy phép MIT License. Xem LICENSE.md để biết thêm thông tin.

(back to top)

Liên hệ

Đội ngũ của Safe You - safeyou@gmail.com