Cài đặt - MkDocs
Hướng dẫn chi tiết.
Yêu cầu
MkDocs yêu cầu phiên bản Python mới nhất và trình quản lý gói Python, pip , phải được cài đặt trên hệ thống của bạn.
Bạn có thể kiểm tra xem bạn đã cài đặt những thứ này chưa từ dòng lệnh:
$ python --version Python 3.8.2 $ pip --version pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)
Nếu bạn đã cài đặt những gói đó, bạn có thể bỏ qua và cài đặt MkDocs .
Cài đặt Python
Cài đặt Python bằng trình quản lý gói bạn chọn hoặc bằng cách tải xuống trình cài đặt phù hợp với hệ thống của bạn từ python.org và chạy nó.
Ghi chú
Nếu bạn đang cài đặt Python trên Windows, hãy nhớ đánh dấu vào ô để thêm Python vào PATH nếu trình cài đặt cung cấp tùy chọn này (thông thường tùy chọn này sẽ tắt theo mặc định).
Cài đặt pip
Nếu bạn đang sử dụng phiên bản Python mới nhất, trình quản lý gói Python, pip , rất có thể được cài đặt theo mặc định. Tuy nhiên, bạn có thể cần nâng cấp pip lên phiên bản mới nhất:
pip install --upgrade pip
Nếu bạn cần cài đặt pip lần đầu tiên, hãy tải xuống get-pip.py . Sau đó chạy lệnh sau để cài đặt:
python get-pip.py
Cài đặt MkDocs
Cài đặt mkdocsgói bằng pip:
pip install mkdocs
Bây giờ bạn đã mkdocscài đặt lệnh trên hệ thống của mình. Chạy mkdocs --versionđể kiểm tra xem mọi thứ có hoạt động bình thường không.
$ mkdocs --version mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)
Ghi chú
Nếu bạn muốn cài đặt manpages cho MkDocs, công cụ click-man có thể tạo và cài đặt chúng cho bạn. Chỉ cần chạy hai lệnh sau:
pip install click-man click-man --target path/to/man/pages mkdocs
Xem tài liệu click-man để biết lý do tại sao các manpage không được pip tự động tạo và cài đặt.
Ghi chú
Nếu bạn đang sử dụng Windows, một số lệnh trên có thể không hoạt động ngay lập tức.
Một giải pháp nhanh chóng có thể là mở đầu mỗi lệnh Python bằng lệnh python -m như sau:
python -m pip install mkdocs python -m mkdocs
Để có giải pháp lâu dài hơn, bạn có thể cần chỉnh sửa PATHbiến môi trường của mình để bao gồm Scriptsthư mục cài đặt Python của bạn. Các phiên bản Python gần đây bao gồm một tập lệnh để thực hiện việc này cho bạn. Điều hướng đến thư mục cài đặt Python của bạn (ví dụ C:\Python38\), mở thư mục Tools, sau đó Scriptsvà chạy win_add2path.pytệp bằng cách nhấp đúp vào tệp đó. Ngoài ra, bạn có thể tải xuống tập lệnh và chạy nó ( python win_add2path.py).