[file-or-directory] File Markdown hoặc thư mục
Đường dẫn tới một file Markdown để đọc hoặc một thư mục để duyệt. Đường dẫn tương đối resolve từ current working directory; bỏ qua khi dừng viewer đang chạy.
Ctrl K
Tóm tắt nhanh / Lệnh
Bộ Engineer
/ak:markdown-novel-viewer
Trình đọc Markdown nhẹ mắt
Mở file Markdown và thư mục trong trình đọc browser nhẹ mắt, có theme ấm, thanh tiến độ, điều hướng plan, phím tắt và Mermaid trực tiếp.
01
Cài phụ thuộc
02
Chọn đường dẫn
03
Khởi động máy chủ xem
04
Render giao diện đọc
Nguyên tắc 01
Đây là trình đọc Markdown tập trung, không phải bộ tạo HTML độc lập
Nguyên tắc 02
Một đường dẫn dùng được cho cả file lẫn thư mục
Nguyên tắc 03
Khi Mermaid lỗi, phải cho thấy nguồn lỗi và hướng sửa
Nguyên tắc 04
Điều hướng plan phải dễ dùng trên cả desktop và mobile
Bản đồ thực thi
Các nhánh chính từ đầu vào đến kết quả, bám theo cách command chạy khi dùng thật.
01
Khởi động
Đầu vào, phạm vi, route
- 1 Cài phụ thuộc Đảm bảo thư mục skill đã cài các gói npm: marked, highlight.js và gray-matter.
- 2 Chọn đường dẫn Nhận file Markdown để đọc hoặc thư mục để mở dạng danh sách có liên kết.
02
Xử lý
Agent / skill thực thi
- 3 Khởi động máy chủ xem Chạy server Node theo chế độ file hoặc thư mục, tự đổi cổng khi cổng mặc định bị chiếm.
- 4 Render giao diện đọc Chuyển Markdown thành giao diện đọc nền ấm, font dễ đọc, highlight code, chiều rộng vừa phải và đổi sáng/tối.
03
Kiểm chứng
Gate, review, xác thực
- 5 Tăng cường điều hướng Với thư mục plan, nhận diện cấu trúc rồi hiển thị sidebar, badge trạng thái, nút trước/sau và bottom sheet trên mobile.
- 6 Render sơ đồ Tự render block Mermaid, cho phóng rộng sơ đồ và hiển thị lỗi parse kèm đoạn nguồn để sửa.
04
Đóng
Báo cáo, bàn giao, artifact
- 7 Hỗ trợ thao tác đọc Có thanh tiến độ, header tự ẩn, phím tắt xem trợ giúp, đổi theme, bật sidebar, chuyển phase và đóng modal.
- 8 Xử lý truy cập Báo rõ lỗi cài đặt, PID cũ, đường dẫn ảnh, cấu hình host truy cập từ xa hoặc lỗi cú pháp Mermaid.
Cú pháp, đối số, subcommand
Cách gọi skill: cú pháp, đối số vị trí, option dùng chung, rồi từng subcommand với cú pháp và kết quả riêng.
Cú pháp
/ak:markdown-novel-viewer [file-or-directory] [--file <path>|--dir <path>] [--port <number>] [--host <addr>] [--open|--no-open] [--background|--foreground] [--stop]Đối số
Option dùng chung
--file <path> Serve file
Serve rõ một file Markdown tại route đọc và cho phép parent directory của file để tải asset nội bộ.
/ak:markdown-novel-viewer --file ./plans/my-plan/plan.md --open--dir <path> Duyệt thư mục
Serve rõ một directory browser. Entry ẩn và thư mục tên deprecated bị loại khỏi danh sách.
/ak:markdown-novel-viewer --dir ./plans --open--port <number> Cổng bắt đầu
Yêu cầu cổng HTTP bắt đầu. Mặc định là 3456 và nếu bận sẽ quét tăng dần tới 3500.
/ak:markdown-novel-viewer ./README.md --port 3460 --open--host <addr> Host bind
Chọn địa chỉ bind. Giữ localhost để chỉ đọc nội bộ; 0.0.0.0 expose viewer trên các network interface khả dụng.
/ak:markdown-novel-viewer ./README.md --host 0.0.0.0 --open--no-open Không mở browser
Tắt hành vi mặc định mở browser của implementation; dùng cho run deterministic, headless hoặc chỉ cần URL.
/ak:markdown-novel-viewer ./README.md --no-open--open Mở browser
Mở browser sau khi server sẵn sàng.
/ak:markdown-novel-viewer ./README.md --open--background Server chạy nền
Spawn child process tách rời, ghi PID state trong thư mục tạm của hệ thống và trả chi tiết khởi động dạng JSON.
/ak:markdown-novel-viewer ./README.md --background --open--foreground Server foreground
Giữ server gắn với tiến trình cho background task do runtime quản lý và xuất JSON khởi động đọc được bằng máy.
/ak:markdown-novel-viewer ./README.md --foreground --no-open--stop Dừng viewer
Dừng mọi instance markdown-novel-viewer được đại diện bởi PID file tìm thấy; kiểm tra instance dùng chung trước khi dùng.
/ak:markdown-novel-viewer --stopPrompt mẫu
Ví dụ gọi command theo từng flag, subcommand, mode hoặc route dùng được trong workflow thực tế.
Đọc file Markdown dài Khuyến nghị
/ak:markdown-novel-viewer plans/feature-auth/plan.md- Dùng khi:
- Dùng khi Markdown dài dễ review hơn trong trình đọc browser ít nhiễu.
- Kết quả:
- Skill mở file ở chế độ đọc với theme sáng/tối ấm, thanh tiến độ, header tự ẩn, highlight code và render Mermaid trực tiếp.
Duyệt thư mục
/ak:markdown-novel-viewer plans/feature-auth- Dùng khi:
- Dùng khi cần xem thư mục Markdown và thư mục con bằng danh sách liên kết trong browser.
- Kết quả:
- Skill mở trình duyệt thư mục có điều hướng lên cấp cha, link thư mục, link Markdown mở bằng chế độ đọc và giao diện sáng/tối đồng bộ.
Review thư mục plan
/ak:markdown-novel-viewer plans/feature-auth- Dùng khi:
- Dùng khi thư mục plan có các file phase và cần điều hướng có cấu trúc khi đọc.
- Kết quả:
- Trình đọc nhận diện cấu trúc plan rồi thêm sidebar accordion, badge trạng thái, nút phase trước/sau và bottom sheet/FAB trên mobile.
Đọc tài liệu có sơ đồ
/ak:markdown-novel-viewer docs/runbooks- Dùng khi:
- Dùng cho RFC, runbook, spec, report hoặc tài liệu dài có sơ đồ Mermaid.
- Kết quả:
- Tài liệu Markdown mở trong trình đọc kiểu sách; Mermaid render theo theme, có thể phóng rộng và hiển thị nguồn/lỗi khi parse thất bại.
Phạm vi xử lý
- Đọc Markdown dài
- Điều hướng thư mục plan
- Render Mermaid trực tiếp
- Giao diện đọc responsive
- Duyệt file qua HTTP nội bộ
Artifact tạo ra
Kết quả trình đọc
Mẫu đường dẫn
URL nội bộ cho /view hoặc /browse Trình đọc Markdown, duyệt thư mục, điều hướng plan, sơ đồ trực tiếp và URL mạng nội bộ khi bind host 0.0.0.0.