📝 KitYAML by Kitmodule

Chuyển đổi JavaScript object thành YAML hoặc Markdown Front Matter — nhẹ, không phụ thuộc thư viện khác, và dễ sử dụng.

English | Tiếng Việt

✨ Tính năng

• 🏷️ Chuyển đổi JavaScript object thành YAML, hỗ trợ nested object và array.
• 📄 Tạo full Markdown front matter với delimiters ---.
• 🔀 Chọn kiểu array: inline hoặc block.
• ⚡ Hoàn toàn vanilla JavaScript, không cần phụ thuộc.
• 💨 Hỗ trợ helper nhanh để tạo front matter chỉ với một dòng: yamlFrontMatter(obj, body).

🚀 Cài đặt

Sử dụng npm

npm install @kitmodule/kityaml-js

Sử dụng CDN

<script src="https://unpkg.com/@kitmodule/kityaml/dist/kityaml.min.js"></script>

hoặc

<script src="https://cdn.jsdelivr.net/npm/kityaml/dist/kityaml.min.js"></script>

💡 Cách dùng

Trình duyệt (CDN)

<script src="https://unpkg.com/@kitmodule/kityaml-js/dist/kityaml.min.js"></script>
<script>
  const obj = { title: "Bài viết của tôi", tags: ["js", "yaml"] };
  const body = "Xin chào thế giới!";

  const yaml = new KitYAML(obj);
  console.log(yaml.frontMatter(body));
</script>

Node.js / CommonJS

const { KitYAML, yamlFrontMatter } = require('kityaml-js');

// Chuyển object thành YAML
const obj = { title: "Bài viết của tôi", tags: ["js", "yaml"] };
const yaml = new KitYAML(obj).block(); // kiểu array block
console.log(yaml.convert());

// Tạo front matter nhanh
console.log(yamlFrontMatter(obj, "Xin chào thế giới!"));

🧩 Tham chiếu API

new KitYAML(obj)

| Tham số | Kiểu | Mô tả | | ------- | ------ | ------------------------------------- | | obj | object | JavaScript object thuần để chuyển đổi |

Instance Methods

| Method | Mô tả | | ------------------------ | ------------------------------------------------ | | .inline(enable = true) | Sử dụng array kiểu inline (["a", "b"]) | | .block(enable = true) | Sử dụng array kiểu block (- a\n- b) | | .convert() | Chuyển object thành chuỗi YAML | | .frontMatter(body="") | Chuyển object + body thành Markdown front matter |

Helper toàn cục

| Function | Mô tả | | ---------------------------- | ------------------------------- | | yamlFrontMatter(obj, body) | Tạo nhanh Markdown front matter |

🧪 Ví dụ Output

const obj = { title: "Bài viết của tôi", tags: ["js", "yaml"] };
const body = "Đây là nội dung bài viết.";

console.log(yamlFrontMatter(obj, body));

Output:

title: "Bài viết của tôi"
tags:
  - "js"
  - "yaml"
Đây là nội dung bài viết.

☕ Ủng hộ tác giả

Nếu bạn thấy thư viện hữu ích, có thể ủng hộ tôi:

🧾 License

Phát hành theo MIT License © 2025 Huỳnh Nhân Quốc · Open Source @Kit Module