PlantUML cho GitHub: Hiển thị sơ đồ PlantUML trực tiếp trong GitHub
PlantUML cho GitHub, từ PlantUML, là một tiện ích mở rộng Firefox nhúng bản xem trước sơ đồ PlantUML vào các trang GitHub cho tài liệu và quy trình xem xét. Nó hiển thị mã nguồn PlantUML tại chỗ bằng cách sử dụng một công cụ bên phía trình duyệt, vì vậy các cộng tác viên không cần phải xuất hình ảnh thủ công. Tiện ích mở rộng hỗ trợ các chủ đề GitHub, cung cấp một công tắc nguồn/sơ đồ, và nhắm đến các kiến trúc sư phần mềm, nhà phát triển, và nhà văn kỹ thuật cần xem trước sơ đồ nhanh chóng và riêng tư bên trong giao diện kho lưu trữ.
Cách nó thay đổi tài liệu và quy trình xem xét
Tiện ích mở rộng loại bỏ bước xuất thủ công khỏi quy trình tài liệu bằng cách hiển thị các sơ đồ trực tiếp, điều này tăng tốc độ xác minh hình ảnh trong quá trình xem xét mã và viết. Nó hoạt động trên hầu hết các giao diện kho lưu trữ, bao gồm các bề mặt bổ sung như thảo luận và Gists, và mô phỏng mẫu sandboxing của chính GitHub cho các sơ đồ nhúng để nội dung được hiển thị bên cạnh Markdown mà không cần trình xem bên ngoài.
Các cú pháp và định dạng sơ đồ mà nó nhận diện
Hỗ trợ bao gồm các loại sơ đồ PlantUML tiêu chuẩn và bí danh, vì vậy các sơ đồ chuỗi, lớp và hoạt động được hiển thị từ văn bản gốc của chúng. Tiện ích mở rộng chấp nhận các bí danh ngôn ngữ như 'puml' và 'wsd' và giữ nguyên nguồn gốc trong chế độ xem có thể chuyển đổi cho thấy văn bản với định dạng nổi bật cú pháp gốc của GitHub, điều này giúp người xem xét kiểm tra hoặc sao chép mô hình cơ bản trực tiếp.
Cách nó xử lý quyền riêng tư, quyền hạn và hiệu suất
Việc hiển thị được thiết kế để tránh máy chủ bên ngoài và theo dõi, sử dụng kiến trúc không theo dõi, không máy chủ và triết lý không quyền hạn mà tối thiểu hóa quyền truy cập trình duyệt cần thiết. Tiện ích mở rộng chạy cục bộ trong ngữ cảnh trang và cũng tương thích với các trình duyệt dựa trên Chromium nơi cùng một cách tiếp cận được áp dụng. Việc hiển thị cục bộ mang lại các sơ đồ ngay lập tức tại chỗ, một hành vi được báo cáo là nhanh chóng trong phản hồi của cộng đồng.
Một lựa chọn thực tiễn cho các cộng tác viên cá nhân và các nhóm chú trọng đến quyền riêng tư
PlantUML cho GitHub là một công cụ thực dụng cho các nhà phát triển và tác giả tài liệu muốn có bản xem trước nhanh chóng trong kho lưu trữ mà không cần gửi dữ liệu sơ đồ đến các dịch vụ bên thứ ba, điều này được phản ánh qua các đánh giá tích cực trên cửa hàng Firefox Add-ons. Nó ít phù hợp hơn cho các nhóm yêu cầu các quy trình hình ảnh tập trung, phía máy chủ hoặc tài sản hình ảnh được lưu trữ trong kho lưu trữ. Đối với các người đánh giá, hãy kích hoạt tiện ích mở rộng trong quá trình hướng dẫn để rút ngắn thời gian kiểm tra trực quan.