Viết bằng Markdown

Markdown phù hợp tốt cho ghi chú nghiên cứu, báo cáo và bản nháp sớm. Oleafly cung cấp cho nó một thanh định dạng riêng và một đường dựng bằng Pandoc, với các tệp nguồn bạn có thể dùng bên ngoài ứng dụng.

Tạo một báo cáo

1. Chọn New project → Use a template → Blank Markdown document.
2. Đặt tên dự án là Ghi chú thực địa và mở main.md.
3. Dán ví dụ này, rồi chọn Recompile hoặc nhấn ⌘Enter / Ctrl+Enter.
4. Nếu Oleafly đề nghị thiết lập một engine cần thiết, hoàn tất thiết lập đó và biên dịch lại.

main.md

---
title: "Field notes"
author: "Alex Chen"
date: ""
---

# Question

Does the revised procedure reduce measurement time?

## Method

1. Prepare the sample.
2. Repeat the measurement three times.
3. Record the elapsed time.

## Observations

| Run | Time (s) | Note |
| --- | --- | --- |
| 1 | 12 | First pass |
| 2 | 10 | Repeated pass |

The **mean time** will be compared with the baseline.

PDF cần có một tiêu đề, các đề mục, một danh sách đánh số và một bảng. Siêu dữ liệu nằm giữa cặp dòng --- đầu tiên điều khiển tiêu đề và tác giả của tài liệu.

Soạn thảo mã nguồn và Visual

Công tắc ở đầu thanh công cụ có ba chế độ. Code chỉnh sửa Markdown trực tiếp. Visual cung cấp soạn thảo có định dạng cho tiêu đề, đoạn văn, danh sách, liên kết, hình ảnh và bảng. Both hiển thị mã nguồn và văn bản đã định dạng cạnh nhau. Mở menu của nó để chọn Stacked hoặc Split. Dự án mới mở ở chế độ Code, và mỗi dự án ghi nhớ chế độ bạn để lại.

Gạch chân, tô sáng, chỉ số trên và chỉ số dưới là các nút định dạng Pandoc ở chế độ Code. Nút của chúng bị ẩn ở chế độ Visual. Dùng Code khi làm việc với siêu dữ liệu, cú pháp trích dẫn hoặc các thành phần mã nguồn khác.

Tải mã nguồn ví dụ

Mọi công cụ trên thanh công cụ

Chọn văn bản trước khi nhấp một nút định dạng. Ở chế độ Code, hầu hết công cụ sẽ bọc phần chọn hoặc chèn một phần giữ chỗ. Mở More formatting options (…) để đến những nút không vừa trên thanh.

Code / Visual

Chuyển giữa Code, Visual và Both. Tài liệu vẫn là mã nguồn Markdown trong mọi chế độ.

Undo

Hoàn tác chỉnh sửa gần nhất. ⌘Z / Ctrl+Z.

Redo

Làm lại một chỉnh sửa đã hoàn tác. ⌘Shift+Z / Ctrl+Shift+Z.

Heading → Title

Chọn Title từ menu tiêu đề để chèn # Title. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Heading → Section

Chọn Section từ menu tiêu đề để chèn ## Section. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Heading → Subsection

Chọn Subsection từ menu tiêu đề để chèn ### Subsection. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Heading → Subsubsection

Chọn Subsubsection từ menu tiêu đề để chèn #### Subsubsection. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Heading → Minor heading

Chọn Minor heading từ menu tiêu đề để chèn ##### Minor heading. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Heading → Paragraph heading

Chọn Paragraph heading từ menu tiêu đề để chèn ###### Paragraph heading. Thay văn bản tiêu đề bằng tiêu đề của riêng bạn.

Bulleted list

Bắt đầu một danh sách không thứ tự. - Item.

Numbered list

Bắt đầu một dãy có thứ tự. 1. Item.

Task list

Ở chế độ Code, thêm một việc và đổi [ ] thành [x] khi hoàn thành. - [ ] Task.

Blockquote

Đặt một đoạn trích trên dòng riêng của nó. > quoted text.

Bold

Nhấn mạnh văn bản được chọn. **text**; ⌘B / Ctrl+B.

Italic

Nhấn mạnh một thuật ngữ. *text*; ⌘I / Ctrl+I.

Strikethrough

Đánh dấu văn bản đã lỗi thời. ~~text~~.

Inline code

Định dạng một tên tệp, lệnh hoặc định danh. Văn bản được bao bằng dấu backtick.

Underline

Chọn một cụm từ ở chế độ Code. [text]{.underline}.

Highlight

Chọn một cụm từ ở chế độ Code. [text]{.mark}.

Superscript

Chọn số mũ ở chế độ Code. ^text^.

Subscript

Chọn chỉ số dưới ở chế độ Code. ~text~.

Gạch chân và tô sáng dùng thuộc tính Pandoc để định dạng có thể đi vào PDF. Dùng các nút này thay vì thêm thẻ HTML thô vào bản thảo.

Insert link

Ở chế độ Code: Chèn [link text](url). Thay cả hai phần giữ chỗ.

Ở chế độ Visual: Mở Link URL. Nhập địa chỉ và áp dụng cho phần chọn của bạn. Dùng Remove link để giữ văn bản mà bỏ liên kết.

Insert image

Ở chế độ Code: Chèn ![caption](image-filename). Thay đường dẫn và chú thích.

Ở chế độ Visual: Mở Image file. Nhập một đường dẫn trong dự án như figures/plot.png và áp dụng.

Insert table

Ở chế độ Code: Chèn ba cột, một hàng tiêu đề và hai hàng dữ liệu. Thay tên cột và các ô.

Ở chế độ Visual: Chèn một bảng có thể chỉnh sửa với kích thước ban đầu như vậy.

Draw a diagram

Mở trình soạn thảo sơ đồ ở chế độ Mermaid. Vẽ một lưu đồ trên canvas hoặc chỉnh sửa mã Mermaid, rồi chọn Insert as Mermaid để thêm nó tại vị trí con trỏ dưới dạng một khối mã mermaid trong cặp ba dấu backtick. Xem Sơ đồ Mermaid.

Document insights

Liệt kê các tiêu đề, hình, bảng, phương trình, nhãn, trích dẫn và việc cần làm của tài liệu theo thứ tự trong mã nguồn, mỗi mục liên kết đến dòng của nó. Nó cũng đọc tiêu đề, tác giả, từ khóa, ngày tháng và tóm tắt từ phần front matter, và có thể sao chép chúng cho một mẫu nộp bài. Xem Document insights.

Document settings

Thay đổi lớp tài liệu, khổ giấy, số cột, lề, phông chữ nội dung, cỡ chữ, ngôn ngữ, giãn dòng và đánh số mục. Oleafly ghi các lựa chọn của bạn vào phần front matter YAML mà Pandoc đọc, và thêm một khối front matter nếu tệp chưa có. Xem Document settings.

Project info

Ở chế độ Code: Hiển thị thống kê dự án và thông tin về phần chọn.

Ở chế độ Visual: Hiển thị thống kê cho bề mặt soạn thảo trực quan.

Find

Ở chế độ Code: Mở tìm kiếm trong tệp đang mở bằng ⌘F / Ctrl+F.

Ở chế độ Visual: Nút Find trên thanh công cụ mã nguồn bị ẩn.

Nhập hình ảnh qua cây tệp trước khi tham chiếu đến nó. Giữ đường dẫn hình ảnh tương đối so với bản thảo, để tệp nén mã nguồn chạy được trên máy tính khác.

Phương trình và khối mã

Viết toán học cùng dòng dưới dạng $x^2$. Đặt một phương trình hiển thị giữa hai cặp dấu dollar:

$$
\bar{x} = \frac{1}{n}\sum_{i=1}^{n}x_i
$$

Với một mẫu mã, bao mã bằng ba dấu backtick và đặt ngôn ngữ của nó sau fence mở. Đây là các thành phần mã nguồn; thanh công cụ Markdown không có nút riêng cho phương trình hay khối mã trong fence.

Sơ đồ Mermaid

Chọn Draw a diagram trên thanh công cụ để tạo một lưu đồ Mermaid trong trình soạn thảo sơ đồ. Insert as Mermaid thêm nó dưới dạng một khối mã trong cặp ba dấu backtick:

```mermaid
flowchart LR
  A[Sample] --> B[Measure]
```

Ở chế độ Both, bên đã định dạng vẽ khối đó thành sơ đồ. PDF cần một hình ảnh, nên trình soạn thảo sơ đồ cũng lưu một PNG đã kết xuất tại figures/mermaid-<hash>.png, và lần biên dịch đặt hình ảnh đó vào chỗ của khối mã. Sơ đồ nhờ vậy cũng xuất hiện trong PDF đã biên dịch. Nếu bạn chỉnh sửa khối mã bằng tay sau đó, PDF sẽ hiển thị mã cho đến khi bạn chèn hoặc lưu lại sơ đồ từ trình soạn thảo sơ đồ. Xem Mermaid trong tài liệu Markdown.

Trích dẫn và danh mục tài liệu tham khảo

Nhập hoặc tạo references.bib, thêm bibliography: references.bib vào siêu dữ liệu YAML, và trích dẫn một khóa sẵn có bằng [@citation-key]. Pandoc dùng danh mục tài liệu để tạo các trích dẫn đã định dạng và một danh mục tài liệu tham khảo.

Tìm và quản lý tài liệu tham khảo →

Nhập và xuất

Để giữ một bản nháp sẵn có ở định dạng Markdown, tạo một Blank Markdown document, dán bản nháp vào main.md, rồi nhập hình ảnh và danh mục tài liệu của nó. Lệnh nhập Markdown document riêng trong thư viện hiện chuyển bản nháp sang LaTeX. Các đường nhập dự án giải thích cả hai con đường.

Biên dịch để có PDF, hoặc dùng Export để tạo Word, HTML, Typst, LaTeX hoặc văn bản thuần. Dùng ZIP mã nguồn để chia sẻ Markdown gốc và các tệp đi kèm. Xuất tác phẩm của bạn trình bày trình tự và những điều cần kiểm tra trong tệp đã chuyển đổi.