Tích hợp GitHub
Biến các bản ghi màn hình thành tài liệu Markdown trên GitHub
Ghi lại quy trình làm việc một lần. Clevera sẽ viết hướng dẫn từng bước kèm ảnh chụp màn hình và xuất nó dưới dạng tệp Markdown vào kho lưu trữ và thư mục GitHub bạn chọn, bao gồm cả hình ảnh, trong một commit duy nhất.
Markdown kiểu GitHub
Ảnh chụp màn hình trong repo của bạn
Một commit cho mỗi lần xuất
Hoạt động với Docusaurus và MkDocs
Bạn có thể làm gì
Tài liệu nằm ngay cạnh mã nguồn,
mà không cần ai phải viết thủ công.
Các đội ngũ kỹ thuật lưu trữ tài liệu trong Git vì đó là nơi diễn ra các quy trình đánh giá, lịch sử và bản dựng. Clevera lấp đầy thư mục đó bằng các hướng dẫn minh họa rõ ràng, giúp tài liệu luôn theo kịp sản phẩm.
Tài liệu hóa tính năng trong vài phút
Thực hiện thao tác tính năng một lần trên màn hình. Clevera sẽ biến bản ghi đó thành hướng dẫn bằng văn bản với các bước được đánh số và ảnh chụp màn hình, sẵn sàng cho kho lưu trữ của bạn.
Giữ tài liệu trong quy trình Git thông thường
Mỗi lần xuất là một commit thông thường trên nhánh mặc định, vì vậy trang tài liệu của bạn sẽ được xây dựng lại, lịch sử vẫn dễ đọc và mọi thay đổi đều có thể truy vết.
Ảnh chụp màn hình không bao giờ bị lỗi
Hình ảnh được commit vào kho lưu trữ của bạn bên cạnh tệp Markdown. Chúng vẫn hoạt động mà không cần Clevera, và một repo riêng tư sẽ giữ chúng ở chế độ riêng tư.
Cập nhật hướng dẫn, không phải hàng đống tệp
Giao diện đã thay đổi? Hãy sửa bài viết trong Clevera và xuất lại. Cùng một tệp và hình ảnh của nó sẽ được cập nhật trong một commit mới mà không bị trùng lặp.
Tài liệu bằng mọi ngôn ngữ bạn hỗ trợ
Dịch bài viết trong Clevera, chuyển đổi ngôn ngữ và xuất từng phiên bản vào thư mục riêng, ví dụ như docs/de hoặc docs/ja.
Quyền truy cập bạn kiểm soát
Clevera chỉ nhìn thấy các kho lưu trữ mà bạn cài đặt Ứng dụng GitHub của nó, và nó chỉ có thể đọc và ghi nội dung của chúng.
Cách thức hoạt động
Từ bản ghi đến kho lưu trữ
trong bốn bước.
Kết nối GitHub một lần. Sau đó, mọi bài viết chỉ cách repo của bạn một cú nhấp chuột.
- 1
Kết nối GitHub
Ủy quyền cho ứng dụng Clevera AI và cài đặt nó trên các kho lưu trữ bạn muốn xuất tới. - 2
Clevera viết hướng dẫn
Từ bản ghi màn hình của bạn, Clevera viết bài hướng dẫn: tiêu đề, các bước được đánh số và ảnh chụp màn hình. - 3
Chọn repo và xuất
Trong phần Chia sẻ, mở Xuất, chọn kho lưu trữ và thư mục, rồi nhấp Xuất lên GitHub. - 4
Nó sẽ nằm trong repo của bạn
Tệp Markdown và hình ảnh của nó sẽ đến trong một commit trên nhánh mặc định, sẵn sàng cho bản dựng tài liệu của bạn.
Xem trong Clevera
Xuất lên GitHub,
từ cửa sổ Chia sẻ của bài viết.
Không cần xuất, không cần sao chép và dán, cũng không cần tải ảnh lên thủ công. Cửa sổ Chia sẻ cung cấp cho bạn liên kết và mã nhúng cũng chính là nơi xuất lên GitHub.
Chọn kho lưu trữ và thư mục
Chọn bất kỳ kho lưu trữ nào đã cài đặt ứng dụng và nhập một thư mục, ví dụ như docs hoặc content/guides. Các thư mục chưa tồn tại sẽ được tạo, và Clevera sẽ ghi nhớ lựa chọn của bạn cho lần sau.
Tệp được đặt tên theo tiêu đề bài viết, vì vậy URL trên trang tài liệu của bạn cũng sẽ hiển thị đẹp mắt.
Cập nhật tệp đã tồn tại
Xuất cùng một bài viết vào cùng một thư mục một lần nữa và Clevera sẽ phát hiện tệp hiện có. Cập nhật nó trong một commit mới, hoặc giữ nguyên và thêm phiên bản mới dưới một tiêu đề mới.
Các thay đổi chỉ truyền từ Clevera sang GitHub, vì vậy việc chỉnh sửa trong repo sẽ không bao giờ ghi đè lên bài viết của bạn.
GitHub và phần còn lại trong ngăn xếp tài liệu của bạn
GitHub nằm cạnh GitLab, Bitbucket, Notion, Confluence, Google Docs, GitBook, Help Scout, ReadMe và ClickUp trong cùng một tab Xuất. Kết nối các công cụ mà đội ngũ của bạn sử dụng và xuất cùng một bài viết lên từng công cụ đó.
Được điền sẵn cho bạn
Những gì nằm trong kho lưu trữ của bạn
và những gì bạn quyết định.
Clevera viết Markdown kiểu GitHub hiển thị tốt trên GitHub và trong các trình tạo trang tĩnh. Đây là nội dung chính xác của mỗi lần xuất.
- Kho lưu trữ và thư mụcBạn chọn
- Bất kỳ kho lưu trữ nào đã cài đặt ứng dụng Clevera AI, và bất kỳ thư mục nào trong đó. Thư mục bắt đầu là
docs; để trống cho thư mục gốc của kho lưu trữ. - Tên tệpĐược thiết lập cho bạn
- Tiêu đề bài viết ở dạng chữ thường với dấu gạch ngang, kết thúc bằng
.md. “Create your first invoice” trở thànhcreate-your-first-invoice.md. Các tiêu đề bằng ngôn ngữ khác sẽ được viết bằng chữ Latinh. - Front matterĐược thiết lập cho bạn
- Một khối YAML ngắn với
title,created_at,updated_atvàsource, mà Docusaurus, MkDocs, Jekyll và Hugo đều đọc được. - Định dạngĐược chuyển đổi cho bạn
- Các bước được đánh số, bảng, danh sách việc cần làm và các khối mã được bao quanh với ngôn ngữ của chúng. Các chú thích trở thành cảnh báo GitHub như
[!NOTE]và[!WARNING]; các nút bật tắt trở thành các phần có thể thu gọn. - Ảnh chụp màn hìnhĐược thiết lập cho bạn
- Được commit vào
assets/<file name>/trong cùng thư mục, được liên kết bằng đường dẫn tương đối, kèm theo chú thích của chúng. - CommitĐược thiết lập cho bạn
- Một commit trên nhánh mặc định, với thông báo “Add article: …” hoặc “Update article: …”, được thực hiện bởi tài khoản GitHub đã kết nối Clevera.
- VideoĐược thiết lập cho bạn
- Video được đặt trong bài viết trở thành hình thu nhỏ liên kết đến trình phát của nó, vì các tệp Markdown không thể phát video.
Thiết lập
Thiết lập tích hợp GitHub
trong khoảng hai phút.
Bạn cần một không gian làm việc Clevera trên gói Pro trở lên. Chủ sở hữu không gian làm việc hoặc Quản trị viên kết nối GitHub một lần; sau đó, bất kỳ ai có quyền chỉnh sửa bài viết đều có thể xuất nó. Việc xuất không sử dụng tín dụng.
- 1
Mở Tích hợp
Trong Clevera, mở menu không gian làm việc, chọn Integrations và nhấp Connect trên thẻ GitHub. - 2
Ủy quyền cho ứng dụng Clevera AI
GitHub yêu cầu bạn ủy quyền cho Clevera AI. Nhấp Authorize. - 3
Cài đặt nó trên các kho lưu trữ của bạn
Chọn tài khoản hoặc tổ chức của bạn, sau đó All repositories hoặc Only select repositories. Ứng dụng yêu cầu quyền đọc và ghi Nội dung, và quyền đọc Siêu dữ liệu. - 4
Xuất một bài viết
Trong trình chỉnh sửa bài viết, nhấp Share, mở Publish, nhấp vào ô GitHub, chọn kho lưu trữ và thư mục, rồi nhấp Publish to GitHub. - 5
Mở nó trên GitHub
Khi bạn thấy “Published to GitHub.”, nhấp Open in GitHub để xem tệp.
Các câu hỏi về tích hợp GitHub
Không. Clevera commit trực tiếp vào nhánh mặc định của kho lưu trữ, thường là main. Nếu bảo vệ nhánh yêu cầu pull request hoặc đánh giá, GitHub sẽ từ chối commit; hãy cho phép nó đối với tài khoản đã kết nối, hoặc xuất vào một kho lưu trữ không có quy tắc đó.
Có. Clevera có thể xuất vào bất kỳ kho lưu trữ nào đã cài đặt ứng dụng Clevera AI, công khai hoặc riêng tư. Ảnh chụp màn hình được commit vào kho lưu trữ, vì vậy chúng cũng riêng tư như phần còn lại.
Có. Trỏ thư mục vào nơi trang tài liệu của bạn được xây dựng. Các trình tạo này đọc title trong front matter, và bản dựng thông thường của bạn sẽ nhận commit mới. Kiểm tra xem chủ đề của bạn có hiển thị cảnh báo GitHub và các phần có thể thu gọn hay không.
Không có gì thay đổi trên GitHub cho đến khi bạn xuất lại. Sau đó, Clevera tìm tệp hiện có và cho phép bạn cập nhật nó trong một commit mới. Nếu bạn đổi tên bài viết, tiêu đề mới sẽ trở thành một tệp mới và bạn có thể xóa tệp cũ trên GitHub. Clevera không bao giờ xóa tệp khỏi kho lưu trữ của bạn.
Đọc và ghi Nội dung, để tạo và cập nhật tệp Markdown và hình ảnh của nó, và đọc Siêu dữ liệu, điều mà GitHub yêu cầu để liệt kê các kho lưu trữ. Không gì khác. Bạn chọn kho lưu trữ nào mà ứng dụng có thể nhìn thấy.
Xuất lên GitHub là một phần của gói Pro và Custom, và việc xuất không sử dụng tín dụng. Việc tạo bài viết vẫn sử dụng tín dụng như bình thường. Xem pricing.
Hướng dẫn tiếp theo của bạn, đã có sẵn trong repo.
Ghi lại một lần. Clevera sẽ viết hướng dẫn và commit lên, bao gồm cả ảnh chụp màn hình.