Browse Source

chore: docs

Yaavi 6 months ago
parent
commit
afc4b948af
2 changed files with 26 additions and 0 deletions
  1. 12 0
      docs/en/guide/lunar-folk-festival.md
  2. 14 0
      docs/zh/guide/lunar-folk-festival.md

+ 12 - 0
docs/en/guide/lunar-folk-festival.md

@@ -1,3 +1,15 @@
+# Lunar Folk Festival
+
+```js
+/**
+ * Retrieve lunar festivals (includes fixed festivals and specially calculated festivals)
+ * @param [start] Start date (default: current day)
+ * @param [end] End date (when omitted, only queries the start date)
+ */
+getLunarFestivals('2025-01-28');
+getLunarFestivals('2025-01-28', '2025-01-30');
+```
+
 ### 农历民俗节日与纪念日
 
 #### 正月

+ 14 - 0
docs/zh/guide/lunar-folk-festival.md

@@ -1,3 +1,17 @@
+# 农历民俗节日与纪念日
+
+## 根据阳历日期区间,批量农历民俗节日与纪念日
+
+```js
+/**
+ * 获取农历节日(包含固定节日和特殊计算节日)
+ * @param [start] 开始日期(默认当天)
+ * @param [end] 结束日期(不传时仅查询当天)
+ */
+getLunarFestivals('2025-01-28');
+getLunarFestivals('2025-01-28', '2025-01-30');
+```
+
 ### 农历民俗节日与纪念日
 
 #### 正月