Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Installation docs...

Đang mở Phù hợp với người mới
#57 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
90/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Xem xét tài liệu cài đặt hiện có trong thư mục docs của dự án, có thể nằm dưới 'getting-started' hoặc 'installation'. Issue này đề xuất cập nhật hướng dẫn để đề cập đến cả pip và uv, và cung cấp một ví dụ rõ ràng, trung lập. Kiểm tra tài liệu mkdocs cho các bước cài đặt hiện tại và sửa đổi chúng để bao gồm các lệnh được đề xuất: 'python3 -m venv venv', 'venv/bin/pip install mkdocs' và 'venv/bin/mkdocs', đồng thời liên kết đến tài liệu của uv. Đảm bảo các thay đổi được thực hiện trong các tệp markdown chính xác và xác minh bằng cách xây dựng tài liệu cục bộ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

pip and uv

I suppose let's be staightforward when we can, and link out to step-by-step walk throughs for new comers when needed.

Most of what I'm seeing these days recommends uv and they've got good little docs to point towards.
If we're doc'ing pip then python3 -m venv venv ... venv/bin/pip install mkdocs ... venv/bin/mkdocs is a dependable route.

We might want to use slightly neutral "Install the mkdocs python package..." then the console example.

Ngôn ngữ chính
Python
Star
32
Fork
2
Merge trung bình
8 giờ 51 phút
Pull request đã merge (30 ngày)
15

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của encode/mkdocs

Tất cả issue của encode/mkdocs

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.