Tích hợp ReadMe
Xuất hướng dẫn nhà phát triển lên ReadMe từ bản ghi màn hình
Tài liệu tham khảo API giải thích các điểm cuối (endpoints). Các hướng dẫn của bạn giải thích mọi thứ xung quanh chúng. Ghi lại một luồng công việc một lần, Clevera sẽ viết hướng dẫn kèm ảnh chụp màn hình và xuất nó lên trung tâm nhà phát triển ReadMe của bạn, trong danh mục hướng dẫn mà bạn chọn.
Hướng dẫn trong trung tâm nhà phát triển của bạn
Các chú thích và thẻ mã nguồn ReadMe
Ảnh chụp màn hình được tải lên ReadMe
Cập nhật theo địa chỉ
Bạn có thể làm gì
Các hướng dẫn xoay quanh API của bạn,
được viết từ chính sản phẩm.
Các nhà phát triển truy cập trung tâm ReadMe của bạn để bắt đầu: tạo tài khoản, tìm khóa API, thiết lập webhook, kiểm tra trong bảng điều khiển. Những trang đó là ảnh chụp màn hình và các cú nhấp chuột, và chúng trở nên lỗi thời mỗi khi bảng điều khiển thay đổi. Clevera viết chúng từ một bản ghi.
Bắt đầu, hiển thị từng cú nhấp chuột
Ghi lại đường dẫn từ lúc đăng ký đến lệnh gọi API đầu tiên trong bảng điều khiển của bạn. Clevera biến nó thành một hướng dẫn với các bước được đánh số và ảnh chụp màn hình cho từng bước.
Mã nguồn vẫn là mã nguồn
Các khối mã giữ nguyên ngôn ngữ và tiêu đề của chúng. Các tab chỉ chứa mã sẽ trở thành các tab mã ReadMe, vì vậy một mẫu cURL, Node và Python sẽ nằm cạnh nhau.
Được lưu trữ nơi nhà phát triển tìm kiếm
Chọn một danh mục hướng dẫn, chẳng hạn như Bắt đầu (Getting Started) hoặc Webhooks, và hướng dẫn sẽ xuất hiện ở đó trong phần Hướng dẫn của trung tâm bạn.
Ảnh chụp màn hình được lưu trữ bởi ReadMe
Ảnh chụp màn hình được tải lên ReadMe, vì vậy hướng dẫn vẫn hoạt động ngay cả khi bạn xóa bài viết trong Clevera.
Làm mới hướng dẫn khi bảng điều khiển thay đổi
Ghi lại luồng công việc, cập nhật bài viết trong Clevera và xuất bản lại. Clevera tìm hướng dẫn theo địa chỉ của nó và ghi đè tại chỗ.
An toàn với định dạng trang của ReadMe
Dấu ngoặc nhọn và dấu ngoặc nhọn trong văn bản của bạn được thoát, vì vậy các trình giữ chỗ như {API_KEY} hiển thị chính xác như đã viết.
Cách thức hoạt động
Từ bản ghi đến hướng dẫn ReadMe
trong bốn bước.
Dán khóa API dự án của bạn một lần. Sau đó, bất kỳ bài viết nào trong không gian làm việc đều có thể trở thành hướng dẫn trong trung tâm của bạn.
- 1
Kết nối dự án của bạn
Sao chép khóa API từ Cấu hình dự án ReadMe của bạn, dán vào Clevera và để nó kiểm tra khóa. - 2
Clevera viết hướng dẫn
Từ bản ghi màn hình của bạn, Clevera viết hướng dẫn: các bước, ảnh chụp màn hình, chú thích và mã nguồn. - 3
Chọn danh mục hướng dẫn
Trong Chia sẻ, mở Xuất bản, chọn danh mục hướng dẫn và nhấp vào Xuất bản lên ReadMe. - 4
Nó nằm trong phần Hướng dẫn của bạn
Hướng dẫn xuất hiện trong danh mục đó trong phiên bản chính của dự án, tại một địa chỉ được tạo từ tiêu đề của nó.
Xem trong Clevera
Xuất bản lên ReadMe,
từ cửa sổ Chia sẻ của bài viết.
Không cần dán vào trình chỉnh sửa ReadMe, không cần tải ảnh chụp màn hình từng cái một, không cần viết lại chú thích theo cú pháp của ReadMe. Cửa sổ Chia sẻ sẽ xuất bản hướng dẫn cho bạn.
Một khóa, một dự án
Trong ReadMe, mở dự án của bạn Cấu hình → Khóa API và sao chép khóa. Dán nó vào Clevera và nhấp vào Kiểm tra khóa; Clevera hiển thị dự án mà khóa thuộc về trước khi lưu bất cứ điều gì.
Khóa cung cấp toàn quyền truy cập vào dự án đó, vì vậy hãy giữ bí mật. Để xuất bản sang dự án khác, hãy kết nối lại bằng khóa của dự án đó.
Chọn danh mục hướng dẫn
Dự án hiển thị trung tâm đã kết nối. Chọn một Danh mục hướng dẫn: hướng dẫn sẽ nằm trong phần Hướng dẫn, dưới danh mục đó. Chưa có danh mục nào? Hãy tạo một danh mục trong ReadMe trước.
Địa chỉ được lấy từ tiêu đề, vì vậy “Tạo khóa API đầu tiên của bạn” trở thành /docs/create-your-first-api-key.
Được điền sẵn cho bạn
Những gì xuất hiện trong trung tâm nhà phát triển của bạn
và những gì bạn quyết định.
Clevera chuyển đổi bài viết sang định dạng trang của ReadMe, vì vậy hướng dẫn sử dụng các chú thích, khối mã và nhúng của ReadMe và có thể được chỉnh sửa trong ReadMe như bất kỳ bài viết nào khác.
- Danh mục hướng dẫnBạn chọn
- Bất kỳ danh mục nào trong phần Hướng dẫn của dự án. Clevera xuất bản lên phiên bản chính (ổn định) của tài liệu của bạn.
- Tiêu đề và địa chỉĐược thiết lập cho bạn
- Tiêu đề của bài viết và một địa chỉ được tạo từ nó dưới
/docs/. Nếu địa chỉ đó đã được sử dụng, ReadMe sẽ cấp cho hướng dẫn mới một địa chỉ hơi khác. - Khả năng hiển thịBạn quyết định
- Clevera không thiết lập nó, vì vậy hướng dẫn mới sẽ nhận mặc định của ReadMe: công khai. Thay đổi nó trong ReadMe ngay sau khi xuất bản nếu bạn muốn xem xét trước. Các bản cập nhật giữ nguyên khả năng hiển thị mà hướng dẫn đã có.
- Chú thíchĐược chuyển đổi cho bạn
- Các chú thích ReadMe với tiêu đề của chúng: 📘 cho thông tin và ghi chú, 👍 cho mẹo và thành công, 🚧 cho cảnh báo và ❗️ cho nguy hiểm.
- Mã nguồn và tabĐược chuyển đổi cho bạn
- Các khối mã giữ nguyên ngôn ngữ và tiêu đề. Các tab chỉ chứa mã trở thành các tab mã ReadMe; các tab khác trở thành các phần có nhãn.
- Các bước và nút chuyển đổiĐược chuyển đổi cho bạn
- Các bước được đánh số trở thành danh sách được đánh số với tiêu đề của mỗi bước được in đậm. Các phần có thể thu gọn trở thành các phần mở rộng của ReadMe.
- Ảnh chụp màn hình và videoĐược thiết lập cho bạn
- Ảnh chụp màn hình được tải lên ReadMe cùng với chú thích của chúng. Video được đặt trong bài viết trở thành các nhúng ReadMe; video Clevera cần bật liên kết chia sẻ.
Thiết lập
Thiết lập tích hợp ReadMe
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 và một dự án ReadMe trên ReadMe Refactored với ít nhất một danh mục hướng dẫn. Chủ sở hữu không gian làm việc hoặc Quản trị viên kết nối ReadMe một lần; sau đó, bất kỳ ai có thể chỉnh sửa bài viết đều có thể xuất bản nó. Việc xuất bản không sử dụng tín dụng.
- 1
Sao chép khóa API ReadMe
Trong dự án ReadMe của bạn, mở Cấu hình → Khóa API và sao chép khóa, hoặc tạo khóa mới nếu danh sách trống. - 2
Kết nối ReadMe trong Clevera
Mở menu không gian làm việc, chọn Tích hợp, tìm ReadMe và nhấp vào Kết nối. Dán khóa vào Khóa API và nhấp vào Kiểm tra khóa. - 3
Xác nhận dự án
Khi bạn thấy “Khóa đã được chấp nhận.” và dự án của bạn dưới Các trang web để xuất bản, nhấp vào Kết nối. - 4
Xuất bản một bài viết
Trong trình chỉnh sửa bài viết, nhấp vào Chia sẻ, mở Xuất bản, nhấp vào ô ReadMe, chọn một Danh mục hướng dẫn và nhấp vào Xuất bản lên ReadMe. - 5
Mở nó trong ReadMe
Khi bạn thấy “Đã xuất bản lên ReadMe.”, nhấp vào Mở trong ReadMe, và thiết lập khả năng hiển thị của hướng dẫn nếu nó chưa nên công khai.
Câu hỏi về tích hợp ReadMe
Nó hoạt động với các dự án trên ReadMe Refactored, vì Clevera sử dụng API hiện tại (v2) của ReadMe. Các dự án vẫn còn trên nền tảng cũ của ReadMe không thể kết nối được.
Không. Clevera xuất bản lên phần Hướng dẫn: các trang bắt đầu, hướng dẫn sử dụng và bảng điều khiển xung quanh tài liệu tham khảo của bạn. Các trang tài liệu tham khảo API của bạn vẫn giữ nguyên.
Phiên bản Hướng dẫn chính (ổn định) của dự án bạn.
Có, theo mặc định. Clevera không thiết lập khả năng hiển thị, vì vậy ReadMe sử dụng mặc định của nó, đó là công khai. Ẩn hướng dẫn trong ReadMe ngay sau khi xuất bản nếu bạn muốn xem xét trước; các bản cập nhật sau này sẽ giữ nguyên khả năng hiển thị đó.
Clevera tìm kiếm một hướng dẫn có cùng địa chỉ ở bất kỳ đâu trong phần Hướng dẫn của bạn và hiển thị “Bài viết này đã có trong ReadMe.” Cập nhật nó để ghi đè hướng dẫn tại cùng địa chỉ, hoặc tạo một hướng dẫn mới dưới một tiêu đề mới. Các thay đổi được thực hiện trong ReadMe kể từ lần xuất bản cuối cùng sẽ bị ghi đè bởi bản cập nhật.
Không. Việc xuất bản chỉ đi một chiều, từ Clevera đến ReadMe. Một hướng dẫn trong ReadMe không thay đổi khi bạn chỉnh sửa bài viết trong Clevera cho đến khi bạn xuất bản lại, vì vậy hãy giữ bài viết trong Clevera làm nguồn cho bất kỳ hướng dẫn nào hiển thị bảng điều khiển của bạn.
Chủ sở hữu không gian làm việc hoặc Quản trị viên kết nối ReadMe một lần bằng khóa của dự án. Sau đó, bất kỳ ai có thể chỉnh sửa bài viết đều có thể xuất bản nó lên ReadMe mà không cần nhìn thấy khóa. Người chỉ có thể xem bài viết không thể xuất bản nó.
Có, đó là một tính năng miễn phí riêng biệt. Xem Nhập từ ReadMe và cách Clevera so sánh với ReadMe. Tích hợp này dành cho các nhóm giữ trung tâm nhà phát triển của họ trên ReadMe.
Xuất bản lên ReadMe là một phần của các gói Pro và Custom của Clevera và 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 bảng giá.
Hướng dẫn bắt đầu tiếp theo của bạn, đã có sẵn trong ReadMe.
Ghi lại quy trình một lần. Clevera sẽ viết hướng dẫn và xuất bản lên trung tâm của bạn, bao gồm cả ảnh chụp màn hình.