Vnstock Logo

Cú pháp Markdown, Mermaid và LaTeX được hỗ trợ

Cập nhật lần cuối:

Thảo luận

Mục lục

Markdown Live Editor tập trung vào những thành phần thường xuất hiện trong tài liệu kỹ thuật, ghi chú kiểu Obsidian và nội dung do AI tạo ra. Trang này giúp bạn biết cú pháp nào được hiển thị trực tiếp và khi nào nên chuyển sang chế độ mã nguồn.

Markdown theo cách viết phổ biến trên GitHub

Các thành phần phổ biến gồm:

  • Tiêu đề H1–H6.
  • Chữ đậm, chữ nghiêng và chữ gạch ngang.
  • Liên kết, hình ảnh và trích dẫn.
  • Danh sách không thứ tự, danh sách có thứ tự và danh sách công việc.
  • Mã trong dòng và khối mã.
  • Đường phân cách và bảng.

Khối mã được tô màu cú pháp để dễ đọc khi rà soát tài liệu kỹ thuật.

Bảng có thể chỉnh sửa

Bạn có thể chèn bảng với số hàng và cột tùy chọn. Trong chế độ trực quan, trình đơn chuột phải cho phép thêm hoặc xoá hàng và cột mà không phải căn thủ công dấu |.

Với bảng rộng, markdownLive.tableDisplayMode hỗ trợ:

  • scroll: giữ cấu trúc cột và cuộn ngang.
  • wrap: xuống dòng nội dung để vừa chiều rộng tài liệu.

Khối lưu ý và cảnh báo

Tiện ích hiển thị các khối lưu ý theo phong cách Obsidian/GitHub, chẳng hạn:

MD
> [!NOTE]
> Thông tin bổ sung cho người đọc.

> [!WARNING]
> Kiểm tra cấu hình trước khi tiếp tục.

Các loại phổ biến gồm ghi chú (note), mẹo (tip), quan trọng (important), cảnh báo (warning), thận trọng (caution), thông tin (info), thành công (success), câu hỏi (question), ví dụ (example) và trích dẫn (quote).

Công thức LaTeX với KaTeX

Công thức trong dòng dùng một cặp $, còn công thức tách thành khối dùng $$:

MD
Lợi nhuận kỳ vọng là $E(R) = \sum p_i r_i$.

$$
\sigma^2 = \sum_i p_i(r_i - E(R))^2
$$

Công thức được hiển thị ngay trong tài liệu, giúp bạn kiểm tra ký hiệu mà không cần đọc toàn bộ mã LaTeX.

Sơ đồ Mermaid

Dùng khối mã với ngôn ngữ mermaid:

Bản xem trước Mermaid hỗ trợ phóng to, thu nhỏ, đặt lại, xem toàn màn hình và chỉnh mã nguồn. Điều này đặc biệt hữu ích khi AI tạo sơ đồ trình tự hoặc sơ đồ kiến trúc cần được kiểm tra trực quan.

HTML trong Markdown

HTML viết xen trong Markdown được hiển thị ở chế độ trực quan, bao gồm các cấu trúc như <details><summary>. Khi HTML phức tạp hoặc cần kiểm soát chính xác thuộc tính, hãy sử dụng chế độ mã nguồn.

Chú thích cuối trang và thẻ

Chú thích cuối trang sử dụng cú pháp quen thuộc:

MD
Nội dung cần dẫn giải.[^1]

[^1]: Phần giải thích hoặc nguồn tham khảo.

Thẻ như #nghien-cuu hoặc #kien-truc được nhận diện trong trình soạn thảo và có thể dùng khi tìm kiếm trong đồ thị liên kết.

Tiện ích hỗ trợ Wikilink cơ bản:

MD
[[ten-ghi-chu]]
[[ten-ghi-chu|Nhãn hiển thị]]

[[ để tìm file trong thư mục làm việc. Bạn cũng có thể sử dụng liên kết Markdown tiêu chuẩn:

MD
[Tài liệu kiến trúc](../docs/architecture.md)

Obsidian hỗ trợ thêm nhiều biến thể liên kết đến tiêu đề và khối nội dung. Khi chuyển nội dung từ Obsidian, nên kiểm tra những liên kết nâng cao trong chế độ mã nguồn thay vì mặc định rằng mọi cú pháp đều tương thích.

Nhúng một file Markdown

Dùng cú pháp sau để hiển thị nội dung một ghi chú khác trong tài liệu hiện tại:

MD
![[design-principles]]

Tiện ích đọc file được liên kết, bỏ phần thông tin YAML ở đầu file và hiển thị nội dung nhúng. File nguồn vẫn độc lập, phù hợp khi tái sử dụng định nghĩa, nguyên tắc hoặc phần giới thiệu ở nhiều tài liệu.

Thông tin YAML ở đầu file

YAML ở đầu file được hiển thị trong bảng Properties (Thuộc tính) có thể thu gọn:

YAML
---
title: Kiến trúc hệ thống
author: Vnstock
tags:
  - architecture
  - ai
color: "#6c8cff"
---

Các thông tin này có thể được dùng lại khi in; titlecolor cũng có thể ảnh hưởng đến nhãn và màu của điểm đại diện cho tài liệu trong đồ thị liên kết.

Tiếp theo: Liên kết nội bộ, liên kết ngược và đồ thị.

Footnotes

Thảo luận

Đang tải bình luận...