Bỏ qua để đến nội dung

Thêm một plugin

Thêm một plugin vào wiki gồm ba việc: sao chép thư mục mẫu, điền nội dung, khai báo plugin trong src/data/plugins.mjs. Sidebar và thẻ plugin trên trang chủ đều lấy từ danh sách đó.

Slug là tên thư mục của plugin: chữ thường, ngăn cách bằng dấu gạch ngang, ví dụ turtle-pickaxes.

Thư mục mẫu nằm ở templates/plugin/ và không được build vào site. Nó có một thư mục cho mỗi ngôn ngữ; hãy sao chép cả hai (thay turtle-pickaxes bằng slug của bạn):

Terminal window
cp -r templates/plugin/vi src/content/docs/plugins/turtle-pickaxes
cp -r templates/plugin/en src/content/docs/en/plugins/turtle-pickaxes

Trên PowerShell:

Terminal window
Copy-Item -Recurse templates/plugin/vi src/content/docs/plugins/turtle-pickaxes
Copy-Item -Recurse templates/plugin/en src/content/docs/en/plugins/turtle-pickaxes

Mỗi bản sao có cùng bộ trang: commands (Lệnh), permissions (Quyền) và placeholders. Cả hai ngôn ngữ phải có đủ trang.

  1. Thay PLUGIN_NAME bằng tên plugin và SLUG bằng slug ở mọi nơi trong cả hai thư mục.
  2. Điền từng trang từ nguồn của plugin: plugin.yml, các lớp lệnh và lớp đăng ký placeholder.
  3. Nếu plugin không có placeholder thì xóa trang placeholders ở cả hai ngôn ngữ.
  4. Xóa mọi khối TODO đã được giải quyết. Chỗ nguồn không trả lời được thì giữ khối TODO (:::caution[TODO]).

Mở src/data/plugins.mjs và thêm một mục vào mảng plugins:

export const plugins = [
// ...
{
slug: 'turtle-pickaxes',
name: 'TurtlePickaxes',
description: {
vi: 'Một câu mô tả plugin.',
en: 'One sentence describing the plugin.',
},
},
];

Thứ tự trong mảng là thứ tự trong sidebar và trên trang chủ. description là nội dung thẻ trên trang chủ; thẻ dẫn tới trang Lệnh của plugin. Các trang trong nhóm sidebar được tự phát hiện từ thư mục và sắp xếp theo sidebar.order trong frontmatter.

Terminal window
npm run build

Bản build sẽ lỗi nếu có liên kết hỏng, anchor sai hoặc trang chỉ có ở một ngôn ngữ (trình kiểm tra liên kết của site cũng bắt trang rơi về ngôn ngữ mặc định).

  • Wiki là trang tra cứu lệnh, quyền và placeholder cho quản trị viên máy chủ. Không viết hướng dẫn cài đặt hay cấu hình ở đây.
  • Mọi lệnh, permission node và placeholder phải lấy từ nguồn của plugin. Không bịa. Chỗ nguồn im lặng thì để khối TODO rõ ràng.
  • Không đưa thông tin xác thực, token, URL webhook, tên máy chủ hoặc IP, mật khẩu database vào tài liệu, kể cả khi chúng xuất hiện làm giá trị mặc định: dùng placeholder như <db-password>.
  • Không công bố ngưỡng phát hiện hay chi tiết bên trong của hệ thống chống gian lận.
  • Không đưa lộ trình, kế hoạch hay ghi chú nội bộ vào tài liệu.
  • Giữ nguyên thuật ngữ kỹ thuật (lệnh, permission node, placeholder). Viết tiếng Việt có dấu đầy đủ.